From d5e01130d014493b793d03f8e19033aa906ab07b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 5 Apr 2025 18:00:03 +0000 Subject: [PATCH 1/8] chore(internal): version bump (#230) --- Gemfile.lock | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 553c07ac..95bba502 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - orb-billing (0.1.0.pre.alpha.37) + orb-billing (0.1.0.pre.alpha.38) connection_pool GEM diff --git a/README.md b/README.md index a58418a1..387d7a2e 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "orb-billing", "~> 0.1.0.pre.alpha.37" +gem "orb-billing", "~> 0.1.0.pre.alpha.38" ``` From 62201445cab0f60cb1be36da6196da0fe7787d9b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 5 Apr 2025 18:20:01 +0000 Subject: [PATCH 2/8] chore(internal): rubocop rules (#232) --- .rubocop.yml | 5 +++-- lib/orb/internal/type/converter.rb | 2 -- lib/orb/internal/util.rb | 4 ---- 3 files changed, 3 insertions(+), 8 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index ed34263a..e924c263 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -39,6 +39,8 @@ Layout/LineLength: AllowedPatterns: - "^\\s*#.*$" - ^require(_relative)? + - "Orb::Internal::Type::BaseModel$" + - "^\\s*[A-Z0-9_]+ = :" - "Orb::(Models|Resources|Test)::" Max: 110 @@ -109,8 +111,7 @@ Metrics/MethodLength: Enabled: false Metrics/ModuleLength: - Exclude: - - "**/*.rbi" + Enabled: false Metrics/ParameterLists: Enabled: false diff --git a/lib/orb/internal/type/converter.rb b/lib/orb/internal/type/converter.rb index 623e6d13..af5c4084 100644 --- a/lib/orb/internal/type/converter.rb +++ b/lib/orb/internal/type/converter.rb @@ -3,7 +3,6 @@ module Orb module Internal module Type - # rubocop:disable Metrics/ModuleLength # @api private module Converter # rubocop:disable Lint/UnusedMethodArgument @@ -218,7 +217,6 @@ def dump(target, value) end end end - # rubocop:enable Metrics/ModuleLength end end end diff --git a/lib/orb/internal/util.rb b/lib/orb/internal/util.rb index 50d91ad4..23901dbf 100644 --- a/lib/orb/internal/util.rb +++ b/lib/orb/internal/util.rb @@ -2,8 +2,6 @@ module Orb module Internal - # rubocop:disable Metrics/ModuleLength - # @api private module Util # @api private @@ -694,7 +692,5 @@ def decode_sse(lines) end end end - - # rubocop:enable Metrics/ModuleLength end end From af4a884f3c7eab12b9688cfd3c6d412cbae5bd58 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 5 Apr 2025 23:31:53 +0000 Subject: [PATCH 3/8] chore: always fold up method bodies in sorbet type definitions (#233) --- lib/orb/models/subscription_create_params.rb | 10 +- .../subscription_price_intervals_params.rb | 6 +- ...ubscription_schedule_plan_change_params.rb | 20 +- ...ule_fixed_fee_quantity_updates_response.rb | 2 +- rbi/lib/orb/client.rbi | 6 +- rbi/lib/orb/errors.rbi | 9 +- rbi/lib/orb/internal/page.rbi | 9 +- .../orb/internal/transport/base_client.rbi | 38 +- .../transport/pooled_net_requester.rbi | 18 +- rbi/lib/orb/internal/type/array_of.rbi | 24 +- rbi/lib/orb/internal/type/base_model.rbi | 77 +- rbi/lib/orb/internal/type/base_page.rbi | 15 +- rbi/lib/orb/internal/type/boolean.rbi | 12 +- rbi/lib/orb/internal/type/converter.rbi | 16 +- rbi/lib/orb/internal/type/enum.rbi | 18 +- rbi/lib/orb/internal/type/hash_of.rbi | 24 +- .../orb/internal/type/request_parameters.rbi | 3 +- rbi/lib/orb/internal/type/union.rbi | 30 +- rbi/lib/orb/internal/type/unknown.rbi | 12 +- rbi/lib/orb/internal/util.rbi | 100 +- rbi/lib/orb/models/alert.rbi | 36 +- .../alert_create_for_customer_params.rbi | 15 +- ...rt_create_for_external_customer_params.rbi | 15 +- .../alert_create_for_subscription_params.rbi | 15 +- rbi/lib/orb/models/alert_disable_params.rbi | 6 +- rbi/lib/orb/models/alert_enable_params.rbi | 6 +- rbi/lib/orb/models/alert_list_params.rbi | 7 +- rbi/lib/orb/models/alert_retrieve_params.rbi | 6 +- rbi/lib/orb/models/alert_update_params.rbi | 12 +- rbi/lib/orb/models/amount_discount.rbi | 9 +- rbi/lib/orb/models/billable_metric.rbi | 9 +- .../models/billing_cycle_relative_date.rbi | 3 +- rbi/lib/orb/models/coupon.rbi | 6 +- rbi/lib/orb/models/coupon_archive_params.rbi | 6 +- rbi/lib/orb/models/coupon_create_params.rbi | 18 +- rbi/lib/orb/models/coupon_fetch_params.rbi | 6 +- rbi/lib/orb/models/coupon_list_params.rbi | 3 +- .../coupons/subscription_list_params.rbi | 6 +- rbi/lib/orb/models/credit_note.rbi | 65 +- .../orb/models/credit_note_create_params.rbi | 15 +- .../orb/models/credit_note_fetch_params.rbi | 6 +- .../orb/models/credit_note_list_params.rbi | 7 +- rbi/lib/orb/models/customer.rbi | 73 +- rbi/lib/orb/models/customer_create_params.rbi | 81 +- rbi/lib/orb/models/customer_delete_params.rbi | 6 +- .../customer_fetch_by_external_id_params.rbi | 6 +- rbi/lib/orb/models/customer_fetch_params.rbi | 6 +- rbi/lib/orb/models/customer_list_params.rbi | 7 +- ...gateway_by_external_customer_id_params.rbi | 6 +- ...nc_payment_methods_from_gateway_params.rbi | 6 +- .../customer_update_by_external_id_params.rbi | 81 +- rbi/lib/orb/models/customer_update_params.rbi | 81 +- .../balance_transaction_create_params.rbi | 9 +- .../balance_transaction_create_response.rbi | 25 +- .../balance_transaction_list_params.rbi | 7 +- .../balance_transaction_list_response.rbi | 25 +- .../cost_list_by_external_id_params.rbi | 6 +- .../cost_list_by_external_id_response.rbi | 18 +- .../orb/models/customers/cost_list_params.rbi | 6 +- .../models/customers/cost_list_response.rbi | 18 +- .../credit_list_by_external_id_params.rbi | 3 +- .../credit_list_by_external_id_response.rbi | 6 +- .../models/customers/credit_list_params.rbi | 3 +- .../models/customers/credit_list_response.rbi | 6 +- ...ger_create_entry_by_external_id_params.rbi | 19 +- ...r_create_entry_by_external_id_response.rbi | 171 +- .../credits/ledger_create_entry_params.rbi | 19 +- .../credits/ledger_create_entry_response.rbi | 169 +- .../ledger_list_by_external_id_params.rbi | 13 +- .../ledger_list_by_external_id_response.rbi | 171 +- .../customers/credits/ledger_list_params.rbi | 13 +- .../credits/ledger_list_response.rbi | 161 +- .../top_up_create_by_external_id_params.rbi | 16 +- .../top_up_create_by_external_id_response.rbi | 16 +- .../credits/top_up_create_params.rbi | 16 +- .../credits/top_up_create_response.rbi | 16 +- .../top_up_delete_by_external_id_params.rbi | 6 +- .../credits/top_up_delete_params.rbi | 6 +- .../top_up_list_by_external_id_params.rbi | 6 +- .../top_up_list_by_external_id_response.rbi | 16 +- .../customers/credits/top_up_list_params.rbi | 6 +- .../credits/top_up_list_response.rbi | 16 +- .../orb/models/dimensional_price_group.rbi | 3 +- .../dimensional_price_group_create_params.rbi | 7 +- .../dimensional_price_group_list_params.rbi | 6 +- ...imensional_price_group_retrieve_params.rbi | 6 +- .../orb/models/dimensional_price_groups.rbi | 6 +- ...nsional_price_group_id_retrieve_params.rbi | 6 +- rbi/lib/orb/models/discount.rbi | 3 +- rbi/lib/orb/models/evaluate_price_group.rbi | 9 +- rbi/lib/orb/models/event_deprecate_params.rbi | 6 +- .../orb/models/event_deprecate_response.rbi | 6 +- rbi/lib/orb/models/event_ingest_params.rbi | 9 +- rbi/lib/orb/models/event_ingest_response.rbi | 18 +- rbi/lib/orb/models/event_search_params.rbi | 6 +- rbi/lib/orb/models/event_search_response.rbi | 9 +- rbi/lib/orb/models/event_update_params.rbi | 3 +- rbi/lib/orb/models/event_update_response.rbi | 6 +- .../models/events/backfill_close_params.rbi | 6 +- .../models/events/backfill_close_response.rbi | 10 +- .../models/events/backfill_create_params.rbi | 7 +- .../events/backfill_create_response.rbi | 10 +- .../models/events/backfill_fetch_params.rbi | 6 +- .../models/events/backfill_fetch_response.rbi | 10 +- .../models/events/backfill_list_params.rbi | 6 +- .../models/events/backfill_list_response.rbi | 10 +- .../models/events/backfill_revert_params.rbi | 6 +- .../events/backfill_revert_response.rbi | 10 +- rbi/lib/orb/models/events/event_volumes.rbi | 12 +- .../orb/models/events/volume_list_params.rbi | 6 +- rbi/lib/orb/models/invoice.rbi | 313 +-- rbi/lib/orb/models/invoice_create_params.rbi | 22 +- rbi/lib/orb/models/invoice_fetch_params.rbi | 6 +- .../models/invoice_fetch_upcoming_params.rbi | 6 +- .../invoice_fetch_upcoming_response.rbi | 309 +-- rbi/lib/orb/models/invoice_issue_params.rbi | 6 +- rbi/lib/orb/models/invoice_level_discount.rbi | 3 +- .../invoice_line_item_create_params.rbi | 6 +- .../invoice_line_item_create_response.rbi | 190 +- rbi/lib/orb/models/invoice_list_params.rbi | 13 +- .../orb/models/invoice_mark_paid_params.rbi | 6 +- rbi/lib/orb/models/invoice_pay_params.rbi | 6 +- rbi/lib/orb/models/invoice_update_params.rbi | 6 +- rbi/lib/orb/models/invoice_void_params.rbi | 6 +- rbi/lib/orb/models/item.rbi | 15 +- rbi/lib/orb/models/item_create_params.rbi | 6 +- rbi/lib/orb/models/item_fetch_params.rbi | 6 +- rbi/lib/orb/models/item_list_params.rbi | 6 +- rbi/lib/orb/models/item_update_params.rbi | 15 +- rbi/lib/orb/models/metric_create_params.rbi | 6 +- rbi/lib/orb/models/metric_fetch_params.rbi | 6 +- rbi/lib/orb/models/metric_list_params.rbi | 7 +- rbi/lib/orb/models/metric_update_params.rbi | 6 +- rbi/lib/orb/models/pagination_metadata.rbi | 6 +- rbi/lib/orb/models/percentage_discount.rbi | 9 +- rbi/lib/orb/models/plan.rbi | 329 ++- rbi/lib/orb/models/plan_create_params.rbi | 1087 ++++----- rbi/lib/orb/models/plan_fetch_params.rbi | 6 +- rbi/lib/orb/models/plan_list_params.rbi | 10 +- rbi/lib/orb/models/plan_update_params.rbi | 6 +- .../plans/external_plan_id_fetch_params.rbi | 6 +- .../plans/external_plan_id_update_params.rbi | 6 +- rbi/lib/orb/models/price.rbi | 2005 ++++++---------- rbi/lib/orb/models/price_create_params.rbi | 121 +- rbi/lib/orb/models/price_evaluate_params.rbi | 7 +- .../orb/models/price_evaluate_response.rbi | 6 +- rbi/lib/orb/models/price_fetch_params.rbi | 6 +- rbi/lib/orb/models/price_list_params.rbi | 6 +- rbi/lib/orb/models/price_update_params.rbi | 6 +- .../prices/external_price_id_fetch_params.rbi | 6 +- .../external_price_id_update_params.rbi | 6 +- rbi/lib/orb/models/subscription.rbi | 153 +- .../orb/models/subscription_cancel_params.rbi | 6 +- .../models/subscription_cancel_response.rbi | 161 +- .../orb/models/subscription_create_params.rbi | 2068 ++++++---------- .../models/subscription_create_response.rbi | 161 +- .../subscription_fetch_costs_params.rbi | 6 +- .../subscription_fetch_costs_response.rbi | 18 +- .../orb/models/subscription_fetch_params.rbi | 6 +- .../subscription_fetch_schedule_params.rbi | 7 +- .../subscription_fetch_schedule_response.rbi | 12 +- .../subscription_fetch_usage_params.rbi | 13 +- .../orb/models/subscription_list_params.rbi | 10 +- .../subscription_price_intervals_params.rbi | 1256 ++++------ .../subscription_price_intervals_response.rbi | 161 +- ...bscription_schedule_plan_change_params.rbi | 2107 ++++++----------- ...cription_schedule_plan_change_response.rbi | 169 +- .../subscription_trigger_phase_params.rbi | 6 +- .../subscription_trigger_phase_response.rbi | 161 +- ...ription_unschedule_cancellation_params.rbi | 6 +- ...ption_unschedule_cancellation_response.rbi | 169 +- ...dule_fixed_fee_quantity_updates_params.rbi | 6 +- ...le_fixed_fee_quantity_updates_response.rbi | 205 +- ...unschedule_pending_plan_changes_params.rbi | 6 +- ...schedule_pending_plan_changes_response.rbi | 201 +- ...ption_update_fixed_fee_quantity_params.rbi | 10 +- ...ion_update_fixed_fee_quantity_response.rbi | 169 +- .../orb/models/subscription_update_params.rbi | 7 +- .../subscription_update_trial_params.rbi | 9 +- .../subscription_update_trial_response.rbi | 161 +- rbi/lib/orb/models/subscription_usage.rbi | 67 +- rbi/lib/orb/models/subscriptions.rbi | 6 +- rbi/lib/orb/models/top_level_ping_params.rbi | 6 +- .../orb/models/top_level_ping_response.rbi | 6 +- rbi/lib/orb/models/trial_discount.rbi | 10 +- rbi/lib/orb/models/usage_discount.rbi | 9 +- rbi/lib/orb/request_options.rbi | 6 +- rbi/lib/orb/resources/alerts.rbi | 34 +- rbi/lib/orb/resources/coupons.rbi | 17 +- .../orb/resources/coupons/subscriptions.rbi | 7 +- rbi/lib/orb/resources/credit_notes.rbi | 14 +- rbi/lib/orb/resources/customers.rbi | 34 +- .../customers/balance_transactions.rbi | 11 +- rbi/lib/orb/resources/customers/costs.rbi | 11 +- rbi/lib/orb/resources/customers/credits.rbi | 11 +- .../resources/customers/credits/ledger.rbi | 55 +- .../resources/customers/credits/top_ups.rbi | 25 +- .../resources/dimensional_price_groups.rbi | 14 +- .../external_dimensional_price_group_id.rbi | 6 +- rbi/lib/orb/resources/events.rbi | 18 +- rbi/lib/orb/resources/events/backfills.rbi | 20 +- rbi/lib/orb/resources/events/volume.rbi | 7 +- rbi/lib/orb/resources/invoice_line_items.rbi | 7 +- rbi/lib/orb/resources/invoices.rbi | 35 +- rbi/lib/orb/resources/items.rbi | 17 +- rbi/lib/orb/resources/metrics.rbi | 18 +- rbi/lib/orb/resources/plans.rbi | 74 +- .../orb/resources/plans/external_plan_id.rbi | 10 +- rbi/lib/orb/resources/prices.rbi | 82 +- .../resources/prices/external_price_id.rbi | 10 +- rbi/lib/orb/resources/subscriptions.rbi | 64 +- rbi/lib/orb/resources/top_level.rbi | 6 +- 212 files changed, 5308 insertions(+), 9719 deletions(-) diff --git a/lib/orb/models/subscription_create_params.rb b/lib/orb/models/subscription_create_params.rb index 063546e6..abed9529 100644 --- a/lib/orb/models/subscription_create_params.rb +++ b/lib/orb/models/subscription_create_params.rb @@ -1628,7 +1628,7 @@ class MatrixConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] end @@ -2240,7 +2240,7 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] end @@ -9042,7 +9042,7 @@ class MatrixConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] end @@ -9654,7 +9654,7 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] end @@ -10233,7 +10233,7 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier ] end diff --git a/lib/orb/models/subscription_price_intervals_params.rb b/lib/orb/models/subscription_price_intervals_params.rb index 92118186..39b0be3f 100644 --- a/lib/orb/models/subscription_price_intervals_params.rb +++ b/lib/orb/models/subscription_price_intervals_params.rb @@ -1213,7 +1213,7 @@ class MatrixConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue ] end @@ -1527,7 +1527,7 @@ class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue ] end @@ -2120,7 +2120,7 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier ] end diff --git a/lib/orb/models/subscription_schedule_plan_change_params.rb b/lib/orb/models/subscription_schedule_plan_change_params.rb index 9f87ea1e..69c4ab44 100644 --- a/lib/orb/models/subscription_schedule_plan_change_params.rb +++ b/lib/orb/models/subscription_schedule_plan_change_params.rb @@ -1619,7 +1619,7 @@ class MatrixConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] end @@ -1925,7 +1925,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier ] end @@ -2235,7 +2235,7 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] end @@ -2814,7 +2814,7 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier ] end @@ -3123,7 +3123,7 @@ class BulkConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier ] end @@ -9055,7 +9055,7 @@ class MatrixConfig < Orb::Internal::Type::BaseModel required :matrix_values, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] end @@ -9361,7 +9361,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier ] end @@ -9671,7 +9671,7 @@ class TieredBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] end @@ -10250,7 +10250,7 @@ class BulkBpsConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier ] end @@ -10559,7 +10559,7 @@ class BulkConfig < Orb::Internal::Type::BaseModel required :tiers, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier ] end diff --git a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb index 7a764983..e91deff9 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 @@ -1072,7 +1072,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel required :fixed_fee_quantity_transitions, -> do Orb::Internal::Type::ArrayOf[ - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition ] end, nil?: true diff --git a/rbi/lib/orb/client.rbi b/rbi/lib/orb/client.rbi index fa0d6007..57ae1923 100644 --- a/rbi/lib/orb/client.rbi +++ b/rbi/lib/orb/client.rbi @@ -57,8 +57,7 @@ module Orb # @api private sig { override.returns(T::Hash[String, String]) } - private def auth_headers - end + private def auth_headers; end # Creates and returns a new client for interacting with the API. sig do @@ -84,7 +83,6 @@ module Orb initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY, max_retry_delay: DEFAULT_MAX_RETRY_DELAY, idempotency_header: "Idempotency-Key" - ) - end + ); end end end diff --git a/rbi/lib/orb/errors.rbi b/rbi/lib/orb/errors.rbi index 00b0ccaa..28e9b2b9 100644 --- a/rbi/lib/orb/errors.rbi +++ b/rbi/lib/orb/errors.rbi @@ -32,8 +32,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil) - end + def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end end class APIConnectionError < Orb::Errors::APIError @@ -89,8 +88,7 @@ module Orb ) .returns(T.attached_class) end - def self.for(url:, status:, body:, request:, response:, message: nil) - end + def self.for(url:, status:, body:, request:, response:, message: nil); end sig { returns(Integer) } attr_accessor :status @@ -107,8 +105,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(url:, status:, body:, request:, response:, message: nil) - end + def self.new(url:, status:, body:, request:, response:, message: nil); end end class BadRequestError < Orb::Errors::APIStatusError diff --git a/rbi/lib/orb/internal/page.rbi b/rbi/lib/orb/internal/page.rbi index adea5945..8309312f 100644 --- a/rbi/lib/orb/internal/page.rbi +++ b/rbi/lib/orb/internal/page.rbi @@ -14,8 +14,7 @@ module Orb attr_accessor :pagination_metadata sig { returns(String) } - def inspect - end + def inspect; end class PaginationMetadata < Orb::Internal::Type::BaseModel sig { returns(T::Boolean) } @@ -25,12 +24,10 @@ module Orb attr_accessor :next_cursor sig { params(has_more: T::Boolean, next_cursor: T.nilable(String)).returns(T.attached_class) } - def self.new(has_more:, next_cursor:) - end + def self.new(has_more:, next_cursor:); end sig { override.returns({has_more: T::Boolean, next_cursor: T.nilable(String)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/internal/transport/base_client.rbi b/rbi/lib/orb/internal/transport/base_client.rbi index ffbcf38d..24c8b504 100644 --- a/rbi/lib/orb/internal/transport/base_client.rbi +++ b/rbi/lib/orb/internal/transport/base_client.rbi @@ -52,8 +52,7 @@ module Orb class << self # @api private sig { params(req: Orb::Internal::Transport::BaseClient::RequestComponentsShape).void } - def validate!(req) - end + def validate!(req); end # @api private sig do @@ -65,8 +64,7 @@ module Orb ) ).returns(T::Boolean) end - def should_retry?(status, headers:) - end + def should_retry?(status, headers:); end # @api private sig do @@ -77,8 +75,7 @@ module Orb ) .returns(Orb::Internal::Transport::BaseClient::RequestInputShape) end - def follow_redirect(request, status:, response_headers:) - end + def follow_redirect(request, status:, response_headers:); end # @api private sig do @@ -88,8 +85,7 @@ module Orb ) .void end - def reap_connection!(status, stream:) - end + def reap_connection!(status, stream:); end end # @api private @@ -118,18 +114,14 @@ module Orb max_retry_delay: 0.0, headers: {}, idempotency_header: nil - ) - end - + ); end # @api private sig { overridable.returns(T::Hash[String, String]) } - private def auth_headers - end + private def auth_headers; end # @api private sig { returns(String) } - private def generate_idempotency_key - end + private def generate_idempotency_key; end # @api private sig do @@ -137,13 +129,11 @@ module Orb .params(req: Orb::Internal::Transport::BaseClient::RequestComponentsShape, opts: Orb::Internal::AnyHash) .returns(Orb::Internal::Transport::BaseClient::RequestInputShape) end - private def build_request(req, opts) - end + private def build_request(req, opts); end # @api private sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) } - private def retry_delay(headers, retry_count:) - end + private def retry_delay(headers, retry_count:); end # @api private sig do @@ -155,8 +145,7 @@ module Orb ) .returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) end - private def send_request(request, redirect_count:, retry_count:, send_retry_header:) - end + private def send_request(request, redirect_count:, retry_count:, send_retry_header:); end # Execute the request specified by `req`. This is the method that all resource # methods call into. @@ -197,12 +186,9 @@ module Orb stream: nil, model: Orb::Internal::Type::Unknown, options: {} - ) - end - + ); end sig { returns(String) } - def inspect - end + def inspect; end end end end diff --git a/rbi/lib/orb/internal/transport/pooled_net_requester.rbi b/rbi/lib/orb/internal/transport/pooled_net_requester.rbi index 642db2e4..17d0e0b6 100644 --- a/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +++ b/rbi/lib/orb/internal/transport/pooled_net_requester.rbi @@ -23,13 +23,11 @@ module Orb class << self # @api private sig { params(url: URI::Generic).returns(Net::HTTP) } - def connect(url) - end + def connect(url); end # @api private sig { params(conn: Net::HTTP, deadline: Float).void } - def calibrate_socket_timeout(conn, deadline) - end + def calibrate_socket_timeout(conn, deadline); end # @api private sig do @@ -39,27 +37,23 @@ module Orb ) .returns(Net::HTTPGenericRequest) end - def build_request(request, &blk) - end + def build_request(request, &blk); end end # @api private sig { params(url: URI::Generic, deadline: Float, blk: T.proc.params(arg0: Net::HTTP).void).void } - private def with_pool(url, deadline:, &blk) - end + private def with_pool(url, deadline:, &blk); end # @api private sig do params(request: Orb::Internal::Transport::PooledNetRequester::RequestShape) .returns([Integer, Net::HTTPResponse, T::Enumerable[String]]) end - def execute(request) - end + def execute(request); end # @api private sig { params(size: Integer).returns(T.attached_class) } - def self.new(size: Etc.nprocessors) - end + def self.new(size: Etc.nprocessors); end end end end diff --git a/rbi/lib/orb/internal/type/array_of.rbi b/rbi/lib/orb/internal/type/array_of.rbi index 0935b6a8..2ef09f6e 100644 --- a/rbi/lib/orb/internal/type/array_of.rbi +++ b/rbi/lib/orb/internal/type/array_of.rbi @@ -25,16 +25,13 @@ module Orb ) .returns(T.attached_class) end - def self.[](type_info, spec = {}) - end + def self.[](type_info, spec = {}); end sig(:final) { params(other: T.anything).returns(T::Boolean) } - def ===(other) - end + def ===(other); end sig(:final) { params(other: T.anything).returns(T::Boolean) } - def ==(other) - end + def ==(other); end # @api private sig(:final) do @@ -46,8 +43,7 @@ module Orb state: Orb::Internal::Type::Converter::State) .returns(T.any(T::Array[T.anything], T.anything)) end - def coerce(value, state:) - end + def coerce(value, state:); end # @api private sig(:final) do @@ -55,18 +51,15 @@ module Orb .params(value: T.any(T::Array[T.anything], T.anything)) .returns(T.any(T::Array[T.anything], T.anything)) end - def dump(value) - end + def dump(value); end # @api private sig(:final) { returns(Elem) } - protected def item_type - end + protected def item_type; end # @api private sig(:final) { returns(T::Boolean) } - protected def nilable? - end + protected def nilable?; end # @api private sig(:final) do @@ -80,8 +73,7 @@ module Orb ) .void end - def initialize(type_info, spec = {}) - end + def initialize(type_info, spec = {}); end end end end diff --git a/rbi/lib/orb/internal/type/base_model.rbi b/rbi/lib/orb/internal/type/base_model.rbi index 98ea1fe5..a2bc8581 100644 --- a/rbi/lib/orb/internal/type/base_model.rbi +++ b/rbi/lib/orb/internal/type/base_model.rbi @@ -20,31 +20,29 @@ module Orb sig do returns( T::Hash[ - Symbol, - T.all( - Orb::Internal::Type::BaseModel::KnownFieldShape, - {type_fn: T.proc.returns(Orb::Internal::Type::Converter::Input)} - ) + Symbol, + T.all( + Orb::Internal::Type::BaseModel::KnownFieldShape, + {type_fn: T.proc.returns(Orb::Internal::Type::Converter::Input)} + ) ] ) end - def known_fields - end + def known_fields; end # @api private sig do returns( T::Hash[ - Symbol, - T.all( - Orb::Internal::Type::BaseModel::KnownFieldShape, - {type: Orb::Internal::Type::Converter::Input} - ) + Symbol, + T.all( + Orb::Internal::Type::BaseModel::KnownFieldShape, + {type: Orb::Internal::Type::Converter::Input} + ) ] ) end - def fields - end + def fields; end # @api private sig do @@ -66,8 +64,7 @@ module Orb ) .void end - private def add_field(name_sym, required:, type_info:, spec:) - end + private def add_field(name_sym, required:, type_info:, spec:); end # @api private sig do @@ -82,8 +79,7 @@ module Orb ) .void end - def required(name_sym, type_info, spec = {}) - end + def required(name_sym, type_info, spec = {}); end # @api private sig do @@ -98,32 +94,27 @@ module Orb ) .void end - def optional(name_sym, type_info, spec = {}) - end + def optional(name_sym, type_info, spec = {}); end # @api private # # `request_only` attributes not excluded from `.#coerce` when receiving responses # even if well behaved servers should not send them sig { params(blk: T.proc.void).void } - private def request_only(&blk) - end + private def request_only(&blk); end # @api private # # `response_only` attributes are omitted from `.#dump` when making requests sig { params(blk: T.proc.void).void } - private def response_only(&blk) - end + private def response_only(&blk); end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other) - end + def ==(other); end end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other) - end + def ==(other); end class << self # @api private @@ -135,8 +126,7 @@ module Orb ) .returns(T.any(T.attached_class, T.anything)) end - def coerce(value, state:) - end + def coerce(value, state:); end # @api private sig do @@ -144,8 +134,7 @@ module Orb .params(value: T.any(T.attached_class, T.anything)) .returns(T.any(T::Hash[T.anything, T.anything], T.anything)) end - def dump(value) - end + def dump(value); end end # Returns the raw value associated with the given key, if found. Otherwise, nil is @@ -155,8 +144,7 @@ module Orb # undocumented features. This method does not parse response data into # higher-level types. Lookup by anything other than a Symbol is an ArgumentError. sig { params(key: Symbol).returns(T.nilable(T.anything)) } - def [](key) - end + def [](key); end # Returns a Hash of the data underlying this object. O(1) # @@ -167,8 +155,7 @@ module Orb # This method is not recursive. The returned value is shared by the object, so it # should not be mutated. sig { overridable.returns(Orb::Internal::AnyHash) } - def to_h - end + def to_h; end # Returns a Hash of the data underlying this object. O(1) # @@ -179,29 +166,23 @@ module Orb # This method is not recursive. The returned value is shared by the object, so it # should not be mutated. sig { overridable.returns(Orb::Internal::AnyHash) } - def to_hash - end + def to_hash; end sig { params(keys: T.nilable(T::Array[Symbol])).returns(Orb::Internal::AnyHash) } - def deconstruct_keys(keys) - end + def deconstruct_keys(keys); end sig { params(a: T.anything).returns(String) } - def to_json(*a) - end + def to_json(*a); end sig { params(a: T.anything).returns(String) } - def to_yaml(*a) - end + def to_yaml(*a); end # Create a new instance of a model. sig { params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(T.attached_class) } - def self.new(data = {}) - end + def self.new(data = {}); end sig { returns(String) } - def inspect - end + def inspect; end end end end diff --git a/rbi/lib/orb/internal/type/base_page.rbi b/rbi/lib/orb/internal/type/base_page.rbi index 33453bfd..e6009a6b 100644 --- a/rbi/lib/orb/internal/type/base_page.rbi +++ b/rbi/lib/orb/internal/type/base_page.rbi @@ -8,20 +8,16 @@ module Orb Elem = type_member(:out) sig { overridable.returns(T::Boolean) } - def next_page? - end + def next_page?; end sig { overridable.returns(T.self_type) } - def next_page - end + def next_page; end sig { overridable.params(blk: T.proc.params(arg0: Elem).void).void } - def auto_paging_each(&blk) - end + def auto_paging_each(&blk); end sig { returns(T::Enumerable[Elem]) } - def to_enum - end + def to_enum; end # @api private sig do @@ -33,8 +29,7 @@ module Orb ) .void end - def initialize(client:, req:, headers:, page_data:) - end + def initialize(client:, req:, headers:, page_data:); end end end end diff --git a/rbi/lib/orb/internal/type/boolean.rbi b/rbi/lib/orb/internal/type/boolean.rbi index ab20720c..7e89e364 100644 --- a/rbi/lib/orb/internal/type/boolean.rbi +++ b/rbi/lib/orb/internal/type/boolean.rbi @@ -13,12 +13,10 @@ module Orb final! sig(:final) { params(other: T.anything).returns(T::Boolean) } - def self.===(other) - end + def self.===(other); end sig(:final) { params(other: T.anything).returns(T::Boolean) } - def self.==(other) - end + def self.==(other); end class << self # @api private @@ -27,15 +25,13 @@ module Orb .params(value: T.any(T::Boolean, T.anything), state: Orb::Internal::Type::Converter::State) .returns(T.any(T::Boolean, T.anything)) end - def coerce(value, state:) - end + def coerce(value, state:); end # @api private sig(:final) do override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything)) end - def dump(value) - end + def dump(value); end end end end diff --git a/rbi/lib/orb/internal/type/converter.rbi b/rbi/lib/orb/internal/type/converter.rbi index cecedd66..640cb419 100644 --- a/rbi/lib/orb/internal/type/converter.rbi +++ b/rbi/lib/orb/internal/type/converter.rbi @@ -23,13 +23,11 @@ module Orb state: Orb::Internal::Type::Converter::State ).returns(T.anything) end - def coerce(value, state:) - end + def coerce(value, state:); end # @api private sig { overridable.params(value: T.anything).returns(T.anything) } - def dump(value) - end + def dump(value); end class << self # @api private @@ -47,8 +45,7 @@ module Orb ) .returns(T.proc.returns(T.anything)) end - def self.type_info(spec) - end + def self.type_info(spec); end # @api private # @@ -92,13 +89,10 @@ module Orb # # See implementation below for more details. state: {strictness: true, exactness: {yes: 0, no: 0, maybe: 0}, branched: 0} - ) - end - + ); end # @api private sig { params(target: Orb::Internal::Type::Converter::Input, value: T.anything).returns(T.anything) } - def self.dump(target, value) - end + def self.dump(target, value); end end end end diff --git a/rbi/lib/orb/internal/type/enum.rbi b/rbi/lib/orb/internal/type/enum.rbi index abd6f386..6729f4f7 100644 --- a/rbi/lib/orb/internal/type/enum.rbi +++ b/rbi/lib/orb/internal/type/enum.rbi @@ -20,23 +20,19 @@ module Orb # All of the valid Symbol values for this enum. sig { overridable.returns(T::Array[T.any(NilClass, T::Boolean, Integer, Float, Symbol)]) } - def values - end + def values; end # @api private # # Guard against thread safety issues by instantiating `@values`. sig { void } - private def finalize! - end + private def finalize!; end sig { params(other: T.anything).returns(T::Boolean) } - def ===(other) - end + def ===(other); end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other) - end + def ==(other); end # @api private # @@ -47,13 +43,11 @@ module Orb .params(value: T.any(String, Symbol, T.anything), state: Orb::Internal::Type::Converter::State) .returns(T.any(Symbol, T.anything)) end - def coerce(value, state:) - end + def coerce(value, state:); end # @api private sig { override.params(value: T.any(Symbol, T.anything)).returns(T.any(Symbol, T.anything)) } - def dump(value) - end + def dump(value); end end end end diff --git a/rbi/lib/orb/internal/type/hash_of.rbi b/rbi/lib/orb/internal/type/hash_of.rbi index 2f9f5659..90803134 100644 --- a/rbi/lib/orb/internal/type/hash_of.rbi +++ b/rbi/lib/orb/internal/type/hash_of.rbi @@ -25,16 +25,13 @@ module Orb ) .returns(T.attached_class) end - def self.[](type_info, spec = {}) - end + def self.[](type_info, spec = {}); end sig(:final) { params(other: T.anything).returns(T::Boolean) } - def ===(other) - end + def ===(other); end sig(:final) { params(other: T.anything).returns(T::Boolean) } - def ==(other) - end + def ==(other); end # @api private sig(:final) do @@ -45,8 +42,7 @@ module Orb ) .returns(T.any(Orb::Internal::AnyHash, T.anything)) end - def coerce(value, state:) - end + def coerce(value, state:); end # @api private sig(:final) do @@ -54,18 +50,15 @@ module Orb .params(value: T.any(T::Hash[T.anything, T.anything], T.anything)) .returns(T.any(Orb::Internal::AnyHash, T.anything)) end - def dump(value) - end + def dump(value); end # @api private sig(:final) { returns(Elem) } - protected def item_type - end + protected def item_type; end # @api private sig(:final) { returns(T::Boolean) } - protected def nilable? - end + protected def nilable?; end # @api private sig(:final) do @@ -79,8 +72,7 @@ module Orb ) .void end - def initialize(type_info, spec = {}) - end + def initialize(type_info, spec = {}); end end end end diff --git a/rbi/lib/orb/internal/type/request_parameters.rbi b/rbi/lib/orb/internal/type/request_parameters.rbi index cc2f54cb..f40c08ef 100644 --- a/rbi/lib/orb/internal/type/request_parameters.rbi +++ b/rbi/lib/orb/internal/type/request_parameters.rbi @@ -13,8 +13,7 @@ module Orb module Converter # @api private sig { params(params: T.anything).returns([T.anything, Orb::Internal::AnyHash]) } - def dump_request(params) - end + def dump_request(params); end end end end diff --git a/rbi/lib/orb/internal/type/union.rbi b/rbi/lib/orb/internal/type/union.rbi index 4250a6e3..5a0dd359 100644 --- a/rbi/lib/orb/internal/type/union.rbi +++ b/rbi/lib/orb/internal/type/union.rbi @@ -11,23 +11,19 @@ module Orb # # All of the specified variant info for this union. sig { returns(T::Array[[T.nilable(Symbol), T.proc.returns(Orb::Internal::Type::Converter::Input)]]) } - private def known_variants - end + private def known_variants; end # @api private sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) } - protected def derefed_variants - end + protected def derefed_variants; end # All of the specified variants for this union. sig { overridable.returns(T::Array[T.anything]) } - def variants - end + def variants; end # @api private sig { params(property: Symbol).void } - private def discriminator(property) - end + private def discriminator(property); end # @api private sig do @@ -37,33 +33,27 @@ module Orb ) .void end - private def variant(key, spec = nil) - end + private def variant(key, spec = nil); end # @api private sig { params(value: T.anything).returns(T.nilable(T.anything)) } - private def resolve_variant(value) - end + private def resolve_variant(value); end sig { params(other: T.anything).returns(T::Boolean) } - def ===(other) - end + def ===(other); end sig { params(other: T.anything).returns(T::Boolean) } - def ==(other) - end + def ==(other); end # @api private sig do override.params(value: T.anything, state: Orb::Internal::Type::Converter::State).returns(T.anything) end - def coerce(value, state:) - end + def coerce(value, state:); end # @api private sig { override.params(value: T.anything).returns(T.anything) } - def dump(value) - end + def dump(value); end end end end diff --git a/rbi/lib/orb/internal/type/unknown.rbi b/rbi/lib/orb/internal/type/unknown.rbi index 1ada7716..ba77afcc 100644 --- a/rbi/lib/orb/internal/type/unknown.rbi +++ b/rbi/lib/orb/internal/type/unknown.rbi @@ -13,12 +13,10 @@ module Orb final! sig(:final) { params(other: T.anything).returns(T::Boolean) } - def self.===(other) - end + def self.===(other); end sig(:final) { params(other: T.anything).returns(T::Boolean) } - def self.==(other) - end + def self.==(other); end class << self # @api private @@ -28,13 +26,11 @@ module Orb state: Orb::Internal::Type::Converter::State ).returns(T.anything) end - def coerce(value, state:) - end + def coerce(value, state:); end # @api private sig(:final) { override.params(value: T.anything).returns(T.anything) } - def dump(value) - end + def dump(value); end end end end diff --git a/rbi/lib/orb/internal/util.rbi b/rbi/lib/orb/internal/util.rbi index b2c2d9d2..d2e8eb9d 100644 --- a/rbi/lib/orb/internal/util.rbi +++ b/rbi/lib/orb/internal/util.rbi @@ -6,58 +6,48 @@ module Orb module Util # @api private sig { returns(Float) } - def self.monotonic_secs - end + def self.monotonic_secs; end class << self # @api private sig { returns(String) } - def arch - end + def arch; end # @api private sig { returns(String) } - def os - end + def os; end end class << self # @api private sig { params(input: T.anything).returns(T::Boolean) } - def primitive?(input) - end + def primitive?(input); end # @api private sig { params(input: T.any(String, T::Boolean)).returns(T.any(T::Boolean, T.anything)) } - def coerce_boolean(input) - end + def coerce_boolean(input); end # @api private sig { params(input: T.any(String, T::Boolean)).returns(T.nilable(T::Boolean)) } - def coerce_boolean!(input) - end + def coerce_boolean!(input); end # @api private sig { params(input: T.any(String, Integer)).returns(T.any(Integer, T.anything)) } - def coerce_integer(input) - end + def coerce_integer(input); end # @api private sig { params(input: T.any(String, Integer, Float)).returns(T.any(Float, T.anything)) } - def coerce_float(input) - end + def coerce_float(input); end # @api private sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) } - def coerce_hash(input) - end + def coerce_hash(input); end end class << self # @api private sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) } - private def deep_merge_lr(lhs, rhs, concat: false) - end + private def deep_merge_lr(lhs, rhs, concat: false); end # @api private # @@ -73,9 +63,7 @@ module Orb sentinel: nil, # whether to merge sequences by concatenation. concat: false - ) - end - + ); end # @api private sig do params( @@ -86,35 +74,30 @@ module Orb ) .returns(T.nilable(T.anything)) end - def dig(data, pick, sentinel = nil, &blk) - end + def dig(data, pick, sentinel = nil, &blk); end end class << self # @api private sig { params(uri: URI::Generic).returns(String) } - def uri_origin(uri) - end + def uri_origin(uri); end # @api private sig { params(path: T.any(String, T::Array[String])).returns(String) } - def interpolate_path(path) - end + def interpolate_path(path); end end class << self # @api private sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) } - def decode_query(query) - end + def decode_query(query); end # @api private sig do params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) .returns(T.nilable(String)) end - def encode_query(query) - end + def encode_query(query); end end ParsedUriShape = @@ -131,21 +114,18 @@ module Orb class << self # @api private sig { params(url: T.any(URI::Generic, String)).returns(Orb::Internal::Util::ParsedUriShape) } - def parse_uri(url) - end + def parse_uri(url); end # @api private sig { params(parsed: Orb::Internal::Util::ParsedUriShape).returns(URI::Generic) } - def unparse_uri(parsed) - end + def unparse_uri(parsed); end # @api private sig do params(lhs: Orb::Internal::Util::ParsedUriShape, rhs: Orb::Internal::Util::ParsedUriShape) .returns(URI::Generic) end - def join_parsed_uri(lhs, rhs) - end + def join_parsed_uri(lhs, rhs); end end class << self @@ -157,8 +137,7 @@ module Orb ) .returns(T::Hash[String, String]) end - def normalized_headers(*headers) - end + def normalized_headers(*headers); end end # @api private @@ -167,13 +146,11 @@ module Orb class ReadIOAdapter # @api private sig { params(max_len: T.nilable(Integer)).returns(String) } - private def read_enum(max_len) - end + private def read_enum(max_len); end # @api private sig { params(max_len: T.nilable(Integer), out_string: T.nilable(String)).returns(T.nilable(String)) } - def read(max_len = nil, out_string = nil) - end + def read(max_len = nil, out_string = nil); end # @api private sig do @@ -183,14 +160,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(stream, &blk) - end + def self.new(stream, &blk); end end class << self sig { params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(T::Enumerable[String]) } - def writable_enum(&blk) - end + def writable_enum(&blk); end end class << self @@ -198,18 +173,15 @@ module Orb sig do params(y: Enumerator::Yielder, boundary: String, key: T.any(Symbol, String), val: T.anything).void end - private def write_multipart_chunk(y, boundary:, key:, val:) - end + private def write_multipart_chunk(y, boundary:, key:, val:); end # @api private sig { params(body: T.anything).returns([String, T::Enumerable[String]]) } - private def encode_multipart_streaming(body) - end + private def encode_multipart_streaming(body); end # @api private sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) } - def encode_content(headers, body) - end + def encode_content(headers, body); end # @api private sig do @@ -220,8 +192,7 @@ module Orb ) .returns(T.anything) end - def decode_content(headers, stream:, suppress_error: false) - end + def decode_content(headers, stream:, suppress_error: false); end end class << self @@ -232,13 +203,11 @@ module Orb params(enum: T::Enumerable[T.anything], external: T::Boolean, close: T.proc.void) .returns(T::Enumerable[T.anything]) end - def fused_enum(enum, external: false, &close) - end + def fused_enum(enum, external: false, &close); end # @api private sig { params(enum: T.nilable(T::Enumerable[T.anything])).void } - def close_fused!(enum) - end + def close_fused!(enum); end # @api private sig do @@ -248,8 +217,7 @@ module Orb ) .returns(T::Enumerable[T.anything]) end - def chain_fused(enum, &blk) - end + def chain_fused(enum, &blk); end end ServerSentEvent = @@ -265,8 +233,7 @@ module Orb class << self # @api private sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) } - def decode_lines(enum) - end + def decode_lines(enum); end # @api private # @@ -274,8 +241,7 @@ module Orb sig do params(lines: T::Enumerable[String]).returns(T::Enumerable[Orb::Internal::Util::ServerSentEvent]) end - def decode_sse(lines) - end + def decode_sse(lines); end end end end diff --git a/rbi/lib/orb/models/alert.rbi b/rbi/lib/orb/models/alert.rbi index e5015a1f..5e4e9ae5 100644 --- a/rbi/lib/orb/models/alert.rbi +++ b/rbi/lib/orb/models/alert.rbi @@ -107,8 +107,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Customer < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -119,12 +118,10 @@ module Orb # The customer the alert applies to. sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class Metric < Orb::Internal::Type::BaseModel @@ -133,12 +130,10 @@ module Orb # The metric the alert applies to. sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class Plan < Orb::Internal::Type::BaseModel @@ -167,8 +162,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, external_plan_id:, name:, plan_version:) - end + def self.new(id:, external_plan_id:, name:, plan_version:); end sig do override @@ -181,8 +175,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Subscription < Orb::Internal::Type::BaseModel @@ -191,12 +184,10 @@ module Orb # The subscription the alert applies to. sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class Threshold < Orb::Internal::Type::BaseModel @@ -209,12 +200,10 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:) - end + def self.new(value:); end sig { override.returns({value: Float}) } - def to_hash - end + def to_hash; end end # The type of alert. This must be a valid alert type. @@ -231,8 +220,7 @@ module Orb COST_EXCEEDED = T.let(:cost_exceeded, Orb::Models::Alert::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Alert::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/alert_create_for_customer_params.rbi b/rbi/lib/orb/models/alert_create_for_customer_params.rbi index f4e6b533..49cb0856 100644 --- a/rbi/lib/orb/models/alert_create_for_customer_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_customer_params.rbi @@ -27,8 +27,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(currency:, type:, thresholds: nil, request_options: {}) - end + def self.new(currency:, type:, thresholds: nil, request_options: {}); end sig do override @@ -41,8 +40,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The type of alert to create. This must be a valid alert type. module Type @@ -60,8 +58,7 @@ module Orb T.let(:credit_balance_recovered, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end class Threshold < Orb::Internal::Type::BaseModel @@ -74,12 +71,10 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:) - end + def self.new(value:); end sig { override.returns({value: Float}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi b/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi index d76fd58b..639564fe 100644 --- a/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi @@ -29,8 +29,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(currency:, type:, thresholds: nil, request_options: {}) - end + def self.new(currency:, type:, thresholds: nil, request_options: {}); end sig do override @@ -43,8 +42,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The type of alert to create. This must be a valid alert type. module Type @@ -62,8 +60,7 @@ module Orb T.let(:credit_balance_recovered, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end class Threshold < Orb::Internal::Type::BaseModel @@ -76,12 +73,10 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:) - end + def self.new(value:); end sig { override.returns({value: Float}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/alert_create_for_subscription_params.rbi b/rbi/lib/orb/models/alert_create_for_subscription_params.rbi index edcbc8e8..5db663ee 100644 --- a/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_subscription_params.rbi @@ -27,8 +27,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(thresholds:, type:, metric_id: nil, request_options: {}) - end + def self.new(thresholds:, type:, metric_id: nil, request_options: {}); end sig do override @@ -41,8 +40,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Threshold < Orb::Internal::Type::BaseModel # The value at which an alert will fire. For credit balance alerts, the alert will @@ -54,12 +52,10 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:) - end + def self.new(value:); end sig { override.returns({value: Float}) } - def to_hash - end + def to_hash; end end # The type of alert to create. This must be a valid alert type. @@ -75,8 +71,7 @@ module Orb COST_EXCEEDED = T.let(:cost_exceeded, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/alert_disable_params.rbi b/rbi/lib/orb/models/alert_disable_params.rbi index bc4b3a7a..c1c89785 100644 --- a/rbi/lib/orb/models/alert_disable_params.rbi +++ b/rbi/lib/orb/models/alert_disable_params.rbi @@ -17,12 +17,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(subscription_id: nil, request_options: {}) - end + def self.new(subscription_id: nil, request_options: {}); end sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/alert_enable_params.rbi b/rbi/lib/orb/models/alert_enable_params.rbi index bc6d38fd..ba207aa7 100644 --- a/rbi/lib/orb/models/alert_enable_params.rbi +++ b/rbi/lib/orb/models/alert_enable_params.rbi @@ -17,12 +17,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(subscription_id: nil, request_options: {}) - end + def self.new(subscription_id: nil, request_options: {}); end sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/alert_list_params.rbi b/rbi/lib/orb/models/alert_list_params.rbi index b400aa34..895dd96c 100644 --- a/rbi/lib/orb/models/alert_list_params.rbi +++ b/rbi/lib/orb/models/alert_list_params.rbi @@ -68,9 +68,7 @@ module Orb limit: nil, subscription_id: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -88,8 +86,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/alert_retrieve_params.rbi b/rbi/lib/orb/models/alert_retrieve_params.rbi index 4bb2ec9f..fae64a4a 100644 --- a/rbi/lib/orb/models/alert_retrieve_params.rbi +++ b/rbi/lib/orb/models/alert_retrieve_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/alert_update_params.rbi b/rbi/lib/orb/models/alert_update_params.rbi index f678c2bb..2a987b37 100644 --- a/rbi/lib/orb/models/alert_update_params.rbi +++ b/rbi/lib/orb/models/alert_update_params.rbi @@ -17,8 +17,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(thresholds:, request_options: {}) - end + def self.new(thresholds:, request_options: {}); end sig do override @@ -26,8 +25,7 @@ module Orb {thresholds: T::Array[Orb::Models::AlertUpdateParams::Threshold], request_options: Orb::RequestOptions} ) end - def to_hash - end + def to_hash; end class Threshold < Orb::Internal::Type::BaseModel # The value at which an alert will fire. For credit balance alerts, the alert will @@ -39,12 +37,10 @@ module Orb # Thresholds are used to define the conditions under which an alert will be # triggered. sig { params(value: Float).returns(T.attached_class) } - def self.new(value:) - end + def self.new(value:); end sig { override.returns({value: Float}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/amount_discount.rbi b/rbi/lib/orb/models/amount_discount.rbi index ed420d9d..1ed6115c 100644 --- a/rbi/lib/orb/models/amount_discount.rbi +++ b/rbi/lib/orb/models/amount_discount.rbi @@ -27,8 +27,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil) - end + def self.new(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil); end sig do override @@ -41,8 +40,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -54,8 +52,7 @@ module Orb AMOUNT = T.let(:amount, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::AmountDiscount::DiscountType::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/billable_metric.rbi b/rbi/lib/orb/models/billable_metric.rbi index ca727134..72cdb418 100644 --- a/rbi/lib/orb/models/billable_metric.rbi +++ b/rbi/lib/orb/models/billable_metric.rbi @@ -45,8 +45,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, description:, item:, metadata:, name:, status:) - end + def self.new(id:, description:, item:, metadata:, name:, status:); end sig do override @@ -61,8 +60,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Status extend Orb::Internal::Type::Enum @@ -75,8 +73,7 @@ module Orb ARCHIVED = T.let(:archived, Orb::Models::BillableMetric::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::BillableMetric::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/billing_cycle_relative_date.rbi b/rbi/lib/orb/models/billing_cycle_relative_date.rbi index cda804c2..c5b19cb3 100644 --- a/rbi/lib/orb/models/billing_cycle_relative_date.rbi +++ b/rbi/lib/orb/models/billing_cycle_relative_date.rbi @@ -12,8 +12,7 @@ module Orb END_OF_TERM = T.let(:end_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/coupon.rbi b/rbi/lib/orb/models/coupon.rbi index 1aef46c8..31ef617e 100644 --- a/rbi/lib/orb/models/coupon.rbi +++ b/rbi/lib/orb/models/coupon.rbi @@ -75,15 +75,13 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Discount extend Orb::Internal::Type::Union sig { override.returns([Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount]) } - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/coupon_archive_params.rbi b/rbi/lib/orb/models/coupon_archive_params.rbi index e40d60ef..72e542cf 100644 --- a/rbi/lib/orb/models/coupon_archive_params.rbi +++ b/rbi/lib/orb/models/coupon_archive_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/coupon_create_params.rbi b/rbi/lib/orb/models/coupon_create_params.rbi index 846fdc19..906a14d3 100644 --- a/rbi/lib/orb/models/coupon_create_params.rbi +++ b/rbi/lib/orb/models/coupon_create_params.rbi @@ -68,8 +68,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Discount extend Orb::Internal::Type::Union @@ -82,12 +81,10 @@ module Orb attr_accessor :percentage_discount sig { params(percentage_discount: Float, discount_type: Symbol).returns(T.attached_class) } - def self.new(percentage_discount:, discount_type: :percentage) - end + def self.new(percentage_discount:, discount_type: :percentage); end sig { override.returns({discount_type: Symbol, percentage_discount: Float}) } - def to_hash - end + def to_hash; end end class NewCouponAmountDiscount < Orb::Internal::Type::BaseModel @@ -98,12 +95,10 @@ module Orb attr_accessor :discount_type sig { params(amount_discount: String, discount_type: Symbol).returns(T.attached_class) } - def self.new(amount_discount:, discount_type: :amount) - end + def self.new(amount_discount:, discount_type: :amount); end sig { override.returns({amount_discount: String, discount_type: Symbol}) } - def to_hash - end + def to_hash; end end sig do @@ -112,8 +107,7 @@ module Orb [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/coupon_fetch_params.rbi b/rbi/lib/orb/models/coupon_fetch_params.rbi index 0585bc7c..eef8351d 100644 --- a/rbi/lib/orb/models/coupon_fetch_params.rbi +++ b/rbi/lib/orb/models/coupon_fetch_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/coupon_list_params.rbi b/rbi/lib/orb/models/coupon_list_params.rbi index 8238986b..85f1ecc6 100644 --- a/rbi/lib/orb/models/coupon_list_params.rbi +++ b/rbi/lib/orb/models/coupon_list_params.rbi @@ -52,8 +52,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/coupons/subscription_list_params.rbi b/rbi/lib/orb/models/coupons/subscription_list_params.rbi index 9be23b2c..23ee3a0c 100644 --- a/rbi/lib/orb/models/coupons/subscription_list_params.rbi +++ b/rbi/lib/orb/models/coupons/subscription_list_params.rbi @@ -27,14 +27,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}) - end + def self.new(cursor: nil, limit: nil, request_options: {}); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/credit_note.rbi b/rbi/lib/orb/models/credit_note.rbi index 779a87a5..fcaf2350 100644 --- a/rbi/lib/orb/models/credit_note.rbi +++ b/rbi/lib/orb/models/credit_note.rbi @@ -118,9 +118,7 @@ module Orb type:, voided_at:, discounts: nil - ) - end - + ); end sig do override .returns( @@ -144,8 +142,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Customer < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -155,12 +152,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class LineItem < Orb::Internal::Type::BaseModel @@ -215,8 +210,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil) - end + def self.new(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil); end sig do override @@ -233,8 +227,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class TaxAmount < Orb::Internal::Type::BaseModel # The amount of additional tax incurred by this tax rate. @@ -253,8 +246,7 @@ module Orb params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String)) .returns(T.attached_class) end - def self.new(amount:, tax_rate_description:, tax_rate_percentage:) - end + def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end sig do override.returns( @@ -265,8 +257,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Discount < Orb::Internal::Type::BaseModel @@ -311,9 +302,7 @@ module Orb percentage_discount:, amount_discount: nil, reason: nil - ) - end - + ); end sig do override .returns( @@ -328,8 +317,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -342,8 +330,7 @@ module Orb AMOUNT = T.let(:amount, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol]) } - def self.values - end + def self.values; end end end end @@ -398,8 +385,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -413,8 +399,7 @@ module Orb T.let(:percentage, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol]) } - def self.values - end + def self.values; end end class AppliesToPrice < Orb::Internal::Type::BaseModel @@ -425,12 +410,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end end @@ -446,8 +429,7 @@ module Orb PRODUCT_UNSATISFACTORY = T.let(:"Product unsatisfactory", Orb::Models::CreditNote::Reason::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CreditNote::Reason::TaggedSymbol]) } - def self.values - end + def self.values; end end module Type @@ -460,8 +442,7 @@ module Orb ADJUSTMENT = T.let(:adjustment, Orb::Models::CreditNote::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CreditNote::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end class Discount < Orb::Internal::Type::BaseModel @@ -511,8 +492,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -524,8 +504,7 @@ module Orb PERCENTAGE = T.let(:percentage, Orb::Models::CreditNote::Discount::DiscountType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CreditNote::Discount::DiscountType::TaggedSymbol]) } - def self.values - end + def self.values; end end class AppliesToPrice < Orb::Internal::Type::BaseModel @@ -536,12 +515,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/credit_note_create_params.rbi b/rbi/lib/orb/models/credit_note_create_params.rbi index 9a52c758..5030d917 100644 --- a/rbi/lib/orb/models/credit_note_create_params.rbi +++ b/rbi/lib/orb/models/credit_note_create_params.rbi @@ -26,8 +26,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(line_items:, memo: nil, reason: nil, request_options: {}) - end + def self.new(line_items:, memo: nil, reason: nil, request_options: {}); end sig do override @@ -40,8 +39,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class LineItem < Orb::Internal::Type::BaseModel # The total amount in the invoice's currency to credit this line item. @@ -53,12 +51,10 @@ module Orb attr_accessor :invoice_line_item_id sig { params(amount: String, invoice_line_item_id: String).returns(T.attached_class) } - def self.new(amount:, invoice_line_item_id:) - end + def self.new(amount:, invoice_line_item_id:); end sig { override.returns({amount: String, invoice_line_item_id: String}) } - def to_hash - end + def to_hash; end end # An optional reason for the credit note. @@ -76,8 +72,7 @@ module Orb T.let(:product_unsatisfactory, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/credit_note_fetch_params.rbi b/rbi/lib/orb/models/credit_note_fetch_params.rbi index 0620e015..4bd31f74 100644 --- a/rbi/lib/orb/models/credit_note_fetch_params.rbi +++ b/rbi/lib/orb/models/credit_note_fetch_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/credit_note_list_params.rbi b/rbi/lib/orb/models/credit_note_list_params.rbi index c4462cf9..628e1e25 100644 --- a/rbi/lib/orb/models/credit_note_list_params.rbi +++ b/rbi/lib/orb/models/credit_note_list_params.rbi @@ -50,9 +50,7 @@ module Orb cursor: nil, limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -67,8 +65,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customer.rbi b/rbi/lib/orb/models/customer.rbi index 48d66889..c559e396 100644 --- a/rbi/lib/orb/models/customer.rbi +++ b/rbi/lib/orb/models/customer.rbi @@ -297,9 +297,7 @@ module Orb timezone:, accounting_sync_configuration: nil, reporting_configuration: nil - ) - end - + ); end sig do override .returns( @@ -329,8 +327,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillingAddress < Orb::Internal::Type::BaseModel sig { returns(T.nilable(String)) } @@ -362,8 +359,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city:, country:, line1:, line2:, postal_code:, state:) - end + def self.new(city:, country:, line1:, line2:, postal_code:, state:); end sig do override @@ -378,8 +374,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Hierarchy < Orb::Internal::Type::BaseModel @@ -400,8 +395,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(children:, parent:) - end + def self.new(children:, parent:); end sig do override @@ -412,8 +406,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Child < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -423,12 +416,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class Parent < Orb::Internal::Type::BaseModel @@ -439,12 +430,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end end @@ -464,8 +453,7 @@ module Orb NETSUITE = T.let(:netsuite, Orb::Models::Customer::PaymentProvider::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customer::PaymentProvider::TaggedSymbol]) } - def self.values - end + def self.values; end end class ShippingAddress < Orb::Internal::Type::BaseModel @@ -498,8 +486,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city:, country:, line1:, line2:, postal_code:, state:) - end + def self.new(city:, country:, line1:, line2:, postal_code:, state:); end sig do override @@ -514,8 +501,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class TaxID < Orb::Internal::Type::BaseModel @@ -641,8 +627,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(country:, type:, value:) - end + def self.new(country:, type:, value:); end sig do override @@ -654,8 +639,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Country extend Orb::Internal::Type::Enum @@ -743,8 +727,7 @@ module Orb ZA = T.let(:ZA, Orb::Models::Customer::TaxID::Country::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customer::TaxID::Country::TaggedSymbol]) } - def self.values - end + def self.values; end end module Type @@ -826,8 +809,7 @@ module Orb ZA_VAT = T.let(:za_vat, Orb::Models::Customer::TaxID::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customer::TaxID::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end @@ -845,8 +827,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(accounting_providers:, excluded:) - end + def self.new(accounting_providers:, excluded:); end sig do override @@ -857,8 +838,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AccountingProvider < Orb::Internal::Type::BaseModel sig { returns(T.nilable(String)) } @@ -878,8 +858,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(external_provider_id:, provider_type:) - end + def self.new(external_provider_id:, provider_type:); end sig do override @@ -890,8 +869,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module ProviderType extend Orb::Internal::Type::Enum @@ -924,8 +902,7 @@ module Orb T::Array[Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol] ) end - def self.values - end + def self.values; end end end end @@ -935,12 +912,10 @@ module Orb attr_accessor :exempt sig { params(exempt: T::Boolean).returns(T.attached_class) } - def self.new(exempt:) - end + def self.new(exempt:); end sig { override.returns({exempt: T::Boolean}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customer_create_params.rbi b/rbi/lib/orb/models/customer_create_params.rbi index 69f0ac4f..bbced843 100644 --- a/rbi/lib/orb/models/customer_create_params.rbi +++ b/rbi/lib/orb/models/customer_create_params.rbi @@ -291,9 +291,7 @@ module Orb tax_id: nil, timezone: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -325,8 +323,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel sig do @@ -343,18 +340,17 @@ module Orb params( accounting_providers: T.nilable( T::Array[ - T.any( - Orb::Models::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider, + Orb::Internal::AnyHash + ) ] ), excluded: T.nilable(T::Boolean) ) .returns(T.attached_class) end - def self.new(accounting_providers: nil, excluded: nil) - end + def self.new(accounting_providers: nil, excluded: nil); end sig do override @@ -365,8 +361,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AccountingProvider < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -376,12 +371,10 @@ module Orb attr_accessor :provider_type sig { params(external_provider_id: String, provider_type: String).returns(T.attached_class) } - def self.new(external_provider_id:, provider_type:) - end + def self.new(external_provider_id:, provider_type:); end sig { override.returns({external_provider_id: String, provider_type: String}) } - def to_hash - end + def to_hash; end end end @@ -415,8 +408,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) - end + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end sig do override @@ -431,8 +423,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Hierarchy < Orb::Internal::Type::BaseModel @@ -454,14 +445,12 @@ module Orb params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)) .returns(T.attached_class) end - def self.new(child_customer_ids: nil, parent_customer_id: nil) - end + def self.new(child_customer_ids: nil, parent_customer_id: nil); end sig do override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)}) end - def to_hash - end + def to_hash; end end # This is used for creating charges or invoices in an external system via Orb. @@ -481,8 +470,7 @@ module Orb NETSUITE = T.let(:netsuite, Orb::Models::CustomerCreateParams::PaymentProvider::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CustomerCreateParams::PaymentProvider::TaggedSymbol]) } - def self.values - end + def self.values; end end class ReportingConfiguration < Orb::Internal::Type::BaseModel @@ -490,12 +478,10 @@ module Orb attr_accessor :exempt sig { params(exempt: T::Boolean).returns(T.attached_class) } - def self.new(exempt:) - end + def self.new(exempt:); end sig { override.returns({exempt: T::Boolean}) } - def to_hash - end + def to_hash; end end class ShippingAddress < Orb::Internal::Type::BaseModel @@ -528,8 +514,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) - end + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end sig do override @@ -544,8 +529,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end module TaxConfiguration @@ -565,8 +549,7 @@ module Orb params(tax_exempt: T::Boolean, tax_exemption_code: T.nilable(String), tax_provider: Symbol) .returns(T.attached_class) end - def self.new(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara) - end + def self.new(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara); end sig do override.returns( @@ -577,8 +560,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel @@ -589,12 +571,10 @@ module Orb attr_accessor :tax_provider sig { params(tax_exempt: T::Boolean, tax_provider: Symbol).returns(T.attached_class) } - def self.new(tax_exempt:, tax_provider: :taxjar) - end + def self.new(tax_exempt:, tax_provider: :taxjar); end sig { override.returns({tax_exempt: T::Boolean, tax_provider: Symbol}) } - def to_hash - end + def to_hash; end end sig do @@ -603,8 +583,7 @@ module Orb [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration] ) end - def self.variants - end + def self.variants; end end class TaxID < Orb::Internal::Type::BaseModel @@ -730,8 +709,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(country:, type:, value:) - end + def self.new(country:, type:, value:); end sig do override @@ -743,8 +721,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Country extend Orb::Internal::Type::Enum @@ -833,8 +810,7 @@ module Orb ZA = T.let(:ZA, Orb::Models::CustomerCreateParams::TaxID::Country::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CustomerCreateParams::TaxID::Country::TaggedSymbol]) } - def self.values - end + def self.values; end end module Type @@ -917,8 +893,7 @@ module Orb ZA_VAT = T.let(:za_vat, Orb::Models::CustomerCreateParams::TaxID::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CustomerCreateParams::TaxID::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customer_delete_params.rbi b/rbi/lib/orb/models/customer_delete_params.rbi index add81614..aa38cd9e 100644 --- a/rbi/lib/orb/models/customer_delete_params.rbi +++ b/rbi/lib/orb/models/customer_delete_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi b/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi index 7c4a530d..9be16900 100644 --- a/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customer_fetch_params.rbi b/rbi/lib/orb/models/customer_fetch_params.rbi index 893a2349..a30fa4f8 100644 --- a/rbi/lib/orb/models/customer_fetch_params.rbi +++ b/rbi/lib/orb/models/customer_fetch_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customer_list_params.rbi b/rbi/lib/orb/models/customer_list_params.rbi index 68624014..53c72cf9 100644 --- a/rbi/lib/orb/models/customer_list_params.rbi +++ b/rbi/lib/orb/models/customer_list_params.rbi @@ -50,9 +50,7 @@ module Orb cursor: nil, limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -67,8 +65,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi b/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi index e9811180..a77deb87 100644 --- a/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +++ b/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi b/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi index 305fae3d..ef28db74 100644 --- a/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +++ b/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customer_update_by_external_id_params.rbi b/rbi/lib/orb/models/customer_update_by_external_id_params.rbi index ff5fb8f2..3b1966c1 100644 --- a/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customer_update_by_external_id_params.rbi @@ -299,9 +299,7 @@ module Orb tax_configuration: nil, tax_id: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -332,8 +330,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel sig do @@ -352,18 +349,17 @@ module Orb params( accounting_providers: T.nilable( T::Array[ - T.any( - Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider, + Orb::Internal::AnyHash + ) ] ), excluded: T.nilable(T::Boolean) ) .returns(T.attached_class) end - def self.new(accounting_providers: nil, excluded: nil) - end + def self.new(accounting_providers: nil, excluded: nil); end sig do override @@ -376,8 +372,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AccountingProvider < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -387,12 +382,10 @@ module Orb attr_accessor :provider_type sig { params(external_provider_id: String, provider_type: String).returns(T.attached_class) } - def self.new(external_provider_id:, provider_type:) - end + def self.new(external_provider_id:, provider_type:); end sig { override.returns({external_provider_id: String, provider_type: String}) } - def to_hash - end + def to_hash; end end end @@ -426,8 +419,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) - end + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end sig do override @@ -442,8 +434,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Hierarchy < Orb::Internal::Type::BaseModel @@ -465,14 +456,12 @@ module Orb params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)) .returns(T.attached_class) end - def self.new(child_customer_ids: nil, parent_customer_id: nil) - end + def self.new(child_customer_ids: nil, parent_customer_id: nil); end sig do override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)}) end - def to_hash - end + def to_hash; end end # This is used for creating charges or invoices in an external system via Orb. @@ -501,8 +490,7 @@ module Orb NETSUITE = T.let(:netsuite, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol]) } - def self.values - end + def self.values; end end class ReportingConfiguration < Orb::Internal::Type::BaseModel @@ -510,12 +498,10 @@ module Orb attr_accessor :exempt sig { params(exempt: T::Boolean).returns(T.attached_class) } - def self.new(exempt:) - end + def self.new(exempt:); end sig { override.returns({exempt: T::Boolean}) } - def to_hash - end + def to_hash; end end class ShippingAddress < Orb::Internal::Type::BaseModel @@ -548,8 +534,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) - end + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end sig do override @@ -564,8 +549,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end module TaxConfiguration @@ -585,8 +569,7 @@ module Orb params(tax_exempt: T::Boolean, tax_exemption_code: T.nilable(String), tax_provider: Symbol) .returns(T.attached_class) end - def self.new(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara) - end + def self.new(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara); end sig do override.returns( @@ -597,8 +580,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel @@ -609,12 +591,10 @@ module Orb attr_accessor :tax_provider sig { params(tax_exempt: T::Boolean, tax_provider: Symbol).returns(T.attached_class) } - def self.new(tax_exempt:, tax_provider: :taxjar) - end + def self.new(tax_exempt:, tax_provider: :taxjar); end sig { override.returns({tax_exempt: T::Boolean, tax_provider: Symbol}) } - def to_hash - end + def to_hash; end end sig do @@ -623,8 +603,7 @@ module Orb [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration] ) end - def self.variants - end + def self.variants; end end class TaxID < Orb::Internal::Type::BaseModel @@ -750,8 +729,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(country:, type:, value:) - end + def self.new(country:, type:, value:); end sig do override @@ -763,8 +741,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Country extend Orb::Internal::Type::Enum @@ -854,8 +831,7 @@ module Orb ZA = T.let(:ZA, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol]) } - def self.values - end + def self.values; end end module Type @@ -938,8 +914,7 @@ module Orb ZA_VAT = T.let(:za_vat, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customer_update_params.rbi b/rbi/lib/orb/models/customer_update_params.rbi index 4ef18709..0b35e98d 100644 --- a/rbi/lib/orb/models/customer_update_params.rbi +++ b/rbi/lib/orb/models/customer_update_params.rbi @@ -284,9 +284,7 @@ module Orb tax_configuration: nil, tax_id: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -317,8 +315,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel sig do @@ -335,18 +332,17 @@ module Orb params( accounting_providers: T.nilable( T::Array[ - T.any( - Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider, + Orb::Internal::AnyHash + ) ] ), excluded: T.nilable(T::Boolean) ) .returns(T.attached_class) end - def self.new(accounting_providers: nil, excluded: nil) - end + def self.new(accounting_providers: nil, excluded: nil); end sig do override @@ -357,8 +353,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AccountingProvider < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -368,12 +363,10 @@ module Orb attr_accessor :provider_type sig { params(external_provider_id: String, provider_type: String).returns(T.attached_class) } - def self.new(external_provider_id:, provider_type:) - end + def self.new(external_provider_id:, provider_type:); end sig { override.returns({external_provider_id: String, provider_type: String}) } - def to_hash - end + def to_hash; end end end @@ -407,8 +400,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) - end + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end sig do override @@ -423,8 +415,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Hierarchy < Orb::Internal::Type::BaseModel @@ -446,14 +437,12 @@ module Orb params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)) .returns(T.attached_class) end - def self.new(child_customer_ids: nil, parent_customer_id: nil) - end + def self.new(child_customer_ids: nil, parent_customer_id: nil); end sig do override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)}) end - def to_hash - end + def to_hash; end end # This is used for creating charges or invoices in an external system via Orb. @@ -477,8 +466,7 @@ module Orb NETSUITE = T.let(:netsuite, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol]) } - def self.values - end + def self.values; end end class ReportingConfiguration < Orb::Internal::Type::BaseModel @@ -486,12 +474,10 @@ module Orb attr_accessor :exempt sig { params(exempt: T::Boolean).returns(T.attached_class) } - def self.new(exempt:) - end + def self.new(exempt:); end sig { override.returns({exempt: T::Boolean}) } - def to_hash - end + def to_hash; end end class ShippingAddress < Orb::Internal::Type::BaseModel @@ -524,8 +510,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil) - end + def self.new(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil); end sig do override @@ -540,8 +525,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end module TaxConfiguration @@ -561,8 +545,7 @@ module Orb params(tax_exempt: T::Boolean, tax_exemption_code: T.nilable(String), tax_provider: Symbol) .returns(T.attached_class) end - def self.new(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara) - end + def self.new(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara); end sig do override.returns( @@ -573,8 +556,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel @@ -585,12 +567,10 @@ module Orb attr_accessor :tax_provider sig { params(tax_exempt: T::Boolean, tax_provider: Symbol).returns(T.attached_class) } - def self.new(tax_exempt:, tax_provider: :taxjar) - end + def self.new(tax_exempt:, tax_provider: :taxjar); end sig { override.returns({tax_exempt: T::Boolean, tax_provider: Symbol}) } - def to_hash - end + def to_hash; end end sig do @@ -599,8 +579,7 @@ module Orb [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration] ) end - def self.variants - end + def self.variants; end end class TaxID < Orb::Internal::Type::BaseModel @@ -726,8 +705,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(country:, type:, value:) - end + def self.new(country:, type:, value:); end sig do override @@ -739,8 +717,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Country extend Orb::Internal::Type::Enum @@ -829,8 +806,7 @@ module Orb ZA = T.let(:ZA, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol]) } - def self.values - end + def self.values; end end module Type @@ -913,8 +889,7 @@ module Orb ZA_VAT = T.let(:za_vat, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi b/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi index d7169d64..6025b3ee 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi @@ -26,8 +26,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, type:, description: nil, request_options: {}) - end + def self.new(amount:, type:, description: nil, request_options: {}); end sig do override @@ -40,8 +39,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Type extend Orb::Internal::Type::Enum @@ -55,8 +53,7 @@ module Orb DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi b/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi index e32ceeb7..e02c241e 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi @@ -92,9 +92,7 @@ module Orb invoice:, starting_balance:, type: - ) - end - + ); end sig do override .returns( @@ -112,8 +110,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Action extend Orb::Internal::Type::Enum @@ -152,8 +149,7 @@ module Orb T.let(:external_payment, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditNote < Orb::Internal::Type::BaseModel @@ -162,12 +158,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class Invoice < Orb::Internal::Type::BaseModel @@ -176,12 +170,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end module Type @@ -198,8 +190,7 @@ module Orb T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi b/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi index 9f4a407b..b0652328 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi @@ -51,9 +51,7 @@ module Orb operation_time_lt: nil, operation_time_lte: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -68,8 +66,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi b/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi index 17f52afb..d773104e 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi @@ -88,9 +88,7 @@ module Orb invoice:, starting_balance:, type: - ) - end - + ); end sig do override .returns( @@ -108,8 +106,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Action extend Orb::Internal::Type::Enum @@ -142,8 +139,7 @@ module Orb T.let(:external_payment, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditNote < Orb::Internal::Type::BaseModel @@ -152,12 +148,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class Invoice < Orb::Internal::Type::BaseModel @@ -166,12 +160,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end module Type @@ -186,8 +178,7 @@ module Orb DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi index 702446f3..bfc3a560 100644 --- a/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi @@ -57,8 +57,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # Controls whether Orb returns cumulative costs since the start of the billing # period, or incremental day-by-day costs. If your customer has minimums or @@ -77,8 +76,7 @@ module Orb T.let(:cumulative, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi index b9fb34e3..73edc7d0 100644 --- a/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi @@ -13,12 +13,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(data:) - end + def self.new(data:); end sig { override.returns({data: T::Array[Orb::Models::Customers::CostListByExternalIDResponse::Data]}) } - def to_hash - end + def to_hash; end class Data < Orb::Internal::Type::BaseModel sig { returns(T::Array[Orb::Models::Customers::CostListByExternalIDResponse::Data::PerPriceCost]) } @@ -48,8 +46,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:) - end + def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end sig do override @@ -63,8 +60,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class PerPriceCost < Orb::Internal::Type::BaseModel # The price object @@ -160,8 +156,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(price:, price_id:, subtotal:, total:, quantity: nil) - end + def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end sig do override @@ -204,8 +199,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customers/cost_list_params.rbi b/rbi/lib/orb/models/customers/cost_list_params.rbi index 516b5056..25aa7fe4 100644 --- a/rbi/lib/orb/models/customers/cost_list_params.rbi +++ b/rbi/lib/orb/models/customers/cost_list_params.rbi @@ -57,8 +57,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # Controls whether Orb returns cumulative costs since the start of the billing # period, or incremental day-by-day costs. If your customer has minimums or @@ -75,8 +74,7 @@ module Orb CUMULATIVE = T.let(:cumulative, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/cost_list_response.rbi b/rbi/lib/orb/models/customers/cost_list_response.rbi index ea295af3..3220241a 100644 --- a/rbi/lib/orb/models/customers/cost_list_response.rbi +++ b/rbi/lib/orb/models/customers/cost_list_response.rbi @@ -11,12 +11,10 @@ module Orb params(data: T::Array[T.any(Orb::Models::Customers::CostListResponse::Data, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(data:) - end + def self.new(data:); end sig { override.returns({data: T::Array[Orb::Models::Customers::CostListResponse::Data]}) } - def to_hash - end + def to_hash; end class Data < Orb::Internal::Type::BaseModel sig { returns(T::Array[Orb::Models::Customers::CostListResponse::Data::PerPriceCost]) } @@ -46,8 +44,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:) - end + def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end sig do override @@ -61,8 +58,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class PerPriceCost < Orb::Internal::Type::BaseModel # The price object @@ -158,8 +154,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(price:, price_id:, subtotal:, total:, quantity: nil) - end + def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end sig do override @@ -202,8 +197,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi index 199acaac..1ca12eea 100644 --- a/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi @@ -56,8 +56,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi index 71aee6c1..3cba78de 100644 --- a/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi @@ -62,8 +62,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Status extend Orb::Internal::Type::Enum @@ -78,8 +77,7 @@ module Orb T.let(:pending_payment, Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credit_list_params.rbi b/rbi/lib/orb/models/customers/credit_list_params.rbi index f97d1400..e21c8f52 100644 --- a/rbi/lib/orb/models/customers/credit_list_params.rbi +++ b/rbi/lib/orb/models/customers/credit_list_params.rbi @@ -56,8 +56,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customers/credit_list_response.rbi b/rbi/lib/orb/models/customers/credit_list_response.rbi index e8a5234f..e5b78953 100644 --- a/rbi/lib/orb/models/customers/credit_list_response.rbi +++ b/rbi/lib/orb/models/customers/credit_list_response.rbi @@ -62,8 +62,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Status extend Orb::Internal::Type::Enum @@ -77,8 +76,7 @@ module Orb T.let(:pending_payment, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi index e3d1f14e..a07a9251 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi @@ -122,9 +122,7 @@ module Orb per_unit_cost_basis: nil, void_reason: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -145,8 +143,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module EntryType extend Orb::Internal::Type::Enum @@ -174,8 +171,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::TaggedSymbol] ) end - def self.values - end + def self.values; end end class InvoiceSettings < Orb::Internal::Type::BaseModel @@ -215,8 +211,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) - end + def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end sig do override @@ -229,8 +224,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end # Can only be specified when `entry_type=void`. The reason for the void. @@ -260,8 +254,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::TaggedSymbol] ) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi index eeadeaa3..9826f4e2 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi @@ -125,9 +125,7 @@ module Orb metadata:, starting_balance:, entry_type: :increment - ) - end - + ); end sig do override .returns( @@ -148,8 +146,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -165,8 +162,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -177,8 +173,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -189,12 +184,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -228,12 +221,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -368,9 +360,7 @@ module Orb invoice_id: nil, price_id: nil, entry_type: :decrement - ) - end - + ); end sig do override .returns( @@ -394,8 +384,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -411,8 +400,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -423,8 +411,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -435,12 +422,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -474,12 +459,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -604,9 +588,7 @@ module Orb new_block_expiry_date:, starting_balance:, entry_type: :expiration_change - ) - end - + ); end sig do override .returns( @@ -628,8 +610,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -645,8 +626,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -657,8 +637,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -669,12 +648,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -708,12 +685,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -833,9 +809,7 @@ module Orb metadata:, starting_balance:, entry_type: :credit_block_expiry - ) - end - + ); end sig do override .returns( @@ -856,8 +830,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -873,8 +846,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -885,8 +857,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -897,12 +868,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -936,12 +905,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1067,9 +1035,7 @@ module Orb void_amount:, void_reason:, entry_type: :void - ) - end - + ); end sig do override .returns( @@ -1092,8 +1058,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1109,8 +1074,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1121,8 +1085,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1133,12 +1096,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1172,12 +1133,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1312,9 +1272,7 @@ module Orb void_amount:, void_reason:, entry_type: :void_initiated - ) - end - + ); end sig do override .returns( @@ -1338,8 +1296,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1355,8 +1312,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1367,8 +1323,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1379,12 +1334,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1418,12 +1371,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1543,9 +1495,7 @@ module Orb metadata:, starting_balance:, entry_type: :amendment - ) - end - + ); end sig do override .returns( @@ -1566,8 +1516,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1583,8 +1532,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1595,8 +1543,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1607,12 +1554,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1646,12 +1591,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1661,8 +1605,7 @@ module Orb [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi index e8bcf277..9f419389 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi @@ -112,9 +112,7 @@ module Orb per_unit_cost_basis: nil, void_reason: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -135,8 +133,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module EntryType extend Orb::Internal::Type::Enum @@ -153,8 +150,7 @@ module Orb override .returns(T::Array[Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType::TaggedSymbol]) end - def self.values - end + def self.values; end end class InvoiceSettings < Orb::Internal::Type::BaseModel @@ -194,8 +190,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) - end + def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end sig do override @@ -208,8 +203,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end # Can only be specified when `entry_type=void`. The reason for the void. @@ -228,8 +222,7 @@ module Orb override .returns(T::Array[Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason::TaggedSymbol]) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi index 4fa3829d..d208463e 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi @@ -117,9 +117,7 @@ module Orb metadata:, starting_balance:, entry_type: :increment - ) - end - + ); end sig do override .returns( @@ -140,8 +138,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -157,8 +154,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -169,8 +165,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -181,12 +176,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -220,12 +213,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -352,9 +344,7 @@ module Orb invoice_id: nil, price_id: nil, entry_type: :decrement - ) - end - + ); end sig do override .returns( @@ -378,8 +368,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -395,8 +384,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -407,8 +395,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -419,12 +406,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -458,12 +443,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -584,9 +568,7 @@ module Orb new_block_expiry_date:, starting_balance:, entry_type: :expiration_change - ) - end - + ); end sig do override .returns( @@ -608,8 +590,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -625,8 +606,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -637,8 +617,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -649,12 +628,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -688,12 +665,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -813,9 +789,7 @@ module Orb metadata:, starting_balance:, entry_type: :credit_block_expiry - ) - end - + ); end sig do override .returns( @@ -836,8 +810,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -853,8 +826,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -865,8 +837,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -877,12 +848,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -916,12 +885,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1043,9 +1011,7 @@ module Orb void_amount:, void_reason:, entry_type: :void - ) - end - + ); end sig do override .returns( @@ -1068,8 +1034,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1085,8 +1050,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1097,8 +1061,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1109,12 +1072,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1148,8 +1109,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -1276,9 +1236,7 @@ module Orb void_amount:, void_reason:, entry_type: :void_initiated - ) - end - + ); end sig do override .returns( @@ -1302,8 +1260,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1319,8 +1276,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1331,8 +1287,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1343,12 +1298,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1382,12 +1335,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1499,9 +1451,7 @@ module Orb metadata:, starting_balance:, entry_type: :amendment - ) - end - + ); end sig do override .returns( @@ -1522,8 +1472,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1539,8 +1488,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1551,8 +1499,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1563,12 +1510,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1602,12 +1547,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1617,8 +1561,7 @@ module Orb [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi index 8f3886a3..7bcdbe25 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi @@ -73,9 +73,7 @@ module Orb limit: nil, minimum_amount: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -94,8 +92,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module EntryStatus extend Orb::Internal::Type::Enum @@ -125,8 +122,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus::TaggedSymbol] ) end - def self.values - end + def self.values; end end module EntryType @@ -171,8 +167,7 @@ module Orb override .returns(T::Array[Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType::TaggedSymbol]) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi index b141709c..08c60827 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi @@ -121,9 +121,7 @@ module Orb metadata:, starting_balance:, entry_type: :increment - ) - end - + ); end sig do override .returns( @@ -144,8 +142,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -161,8 +158,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -173,8 +169,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -185,12 +180,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -224,12 +217,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -360,9 +352,7 @@ module Orb invoice_id: nil, price_id: nil, entry_type: :decrement - ) - end - + ); end sig do override .returns( @@ -386,8 +376,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -403,8 +392,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -415,8 +403,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -427,12 +414,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -466,12 +451,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -596,9 +580,7 @@ module Orb new_block_expiry_date:, starting_balance:, entry_type: :expiration_change - ) - end - + ); end sig do override .returns( @@ -620,8 +602,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -637,8 +618,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -649,8 +629,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -661,12 +640,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -700,12 +677,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -825,9 +801,7 @@ module Orb metadata:, starting_balance:, entry_type: :credit_block_expiry - ) - end - + ); end sig do override .returns( @@ -848,8 +822,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -865,8 +838,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -877,8 +849,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -889,12 +860,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -928,12 +897,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1055,9 +1023,7 @@ module Orb void_amount:, void_reason:, entry_type: :void - ) - end - + ); end sig do override .returns( @@ -1080,8 +1046,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1097,8 +1062,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1109,8 +1073,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1121,12 +1084,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1160,12 +1121,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1300,9 +1260,7 @@ module Orb void_amount:, void_reason:, entry_type: :void_initiated - ) - end - + ); end sig do override .returns( @@ -1326,8 +1284,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1343,8 +1300,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1355,8 +1311,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1367,12 +1322,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1406,12 +1359,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1527,9 +1479,7 @@ module Orb metadata:, starting_balance:, entry_type: :amendment - ) - end - + ); end sig do override .returns( @@ -1550,8 +1500,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1567,8 +1516,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1579,8 +1527,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1591,12 +1538,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1630,12 +1575,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1645,8 +1589,7 @@ module Orb [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi index 5925c6bb..45d6d1a4 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi @@ -73,9 +73,7 @@ module Orb limit: nil, minimum_amount: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -94,8 +92,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module EntryStatus extend Orb::Internal::Type::Enum @@ -110,8 +107,7 @@ module Orb PENDING = T.let(:pending, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::Credits::LedgerListParams::EntryStatus::TaggedSymbol]) } - def self.values - end + def self.values; end end module EntryType @@ -134,8 +130,7 @@ module Orb AMENDMENT = T.let(:amendment, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi index 2d3d6102..fa6dd1ad 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi @@ -117,9 +117,7 @@ module Orb metadata:, starting_balance:, entry_type: :increment - ) - end - + ); end sig do override .returns( @@ -140,8 +138,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -157,8 +154,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -169,8 +165,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -181,12 +176,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -220,8 +213,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -348,9 +340,7 @@ module Orb invoice_id: nil, price_id: nil, entry_type: :decrement - ) - end - + ); end sig do override .returns( @@ -374,8 +364,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -391,8 +380,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -403,8 +391,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -415,12 +402,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -454,8 +439,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -572,9 +556,7 @@ module Orb new_block_expiry_date:, starting_balance:, entry_type: :expiration_change - ) - end - + ); end sig do override .returns( @@ -596,8 +578,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -613,8 +594,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -625,8 +605,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -637,12 +616,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -676,12 +653,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -793,9 +769,7 @@ module Orb metadata:, starting_balance:, entry_type: :credit_block_expiry - ) - end - + ); end sig do override .returns( @@ -816,8 +790,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -833,8 +806,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -845,8 +817,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -857,12 +828,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -896,12 +865,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol + Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1019,9 +987,7 @@ module Orb void_amount:, void_reason:, entry_type: :void - ) - end - + ); end sig do override .returns( @@ -1044,8 +1010,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1061,8 +1026,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1073,8 +1037,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1085,12 +1048,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1124,8 +1085,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -1252,9 +1212,7 @@ module Orb void_amount:, void_reason:, entry_type: :void_initiated - ) - end - + ); end sig do override .returns( @@ -1278,8 +1236,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1295,8 +1252,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1307,8 +1263,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1319,12 +1274,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1358,8 +1311,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -1471,9 +1423,7 @@ module Orb metadata:, starting_balance:, entry_type: :amendment - ) - end - + ); end sig do override .returns( @@ -1494,8 +1444,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class CreditBlock < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1511,8 +1460,7 @@ module Orb params(id: String, expiry_date: T.nilable(Time), per_unit_cost_basis: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, expiry_date:, per_unit_cost_basis:) - end + def self.new(id:, expiry_date:, per_unit_cost_basis:); end sig do override.returns( @@ -1523,8 +1471,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -1535,12 +1482,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module EntryStatus @@ -1574,8 +1519,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -1585,8 +1529,7 @@ module Orb [Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi index bce74d21..976e36d0 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi @@ -86,9 +86,7 @@ module Orb expires_after: nil, expires_after_unit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -105,8 +103,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's @@ -142,8 +139,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) - end + def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end sig do override @@ -156,8 +152,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end # The unit of expires_after. @@ -192,8 +187,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi index e80e70d3..64f58954 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi @@ -81,9 +81,7 @@ module Orb threshold:, expires_after: nil, expires_after_unit: nil - ) - end - + ); end sig do override .returns( @@ -101,8 +99,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's @@ -138,8 +135,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) - end + def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end sig do override @@ -152,8 +148,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end # The unit of expires_after. @@ -188,8 +183,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi index 40f58fac..8c2c38ee 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi @@ -76,9 +76,7 @@ module Orb expires_after: nil, expires_after_unit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -95,8 +93,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's @@ -132,8 +129,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) - end + def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end sig do override @@ -146,8 +142,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end # The unit of expires_after. @@ -166,8 +161,7 @@ module Orb override .returns(T::Array[Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi index 697efde4..6a3daba5 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi @@ -69,9 +69,7 @@ module Orb threshold:, expires_after: nil, expires_after_unit: nil - ) - end - + ); end sig do override .returns( @@ -87,8 +85,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's @@ -124,8 +121,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) - end + def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end sig do override @@ -138,8 +134,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end # The unit of expires_after. @@ -165,8 +160,7 @@ module Orb override .returns(T::Array[Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi index b5db25b9..84ea9d12 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi @@ -18,12 +18,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(external_customer_id:, request_options: {}) - end + def self.new(external_customer_id:, request_options: {}); end sig { override.returns({external_customer_id: String, request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi index 44478b3f..ce0484f6 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi @@ -15,12 +15,10 @@ module Orb params(customer_id: String, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(customer_id:, request_options: {}) - end + def self.new(customer_id:, request_options: {}); end sig { override.returns({customer_id: String, request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi index eda80102..d6a10505 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi @@ -28,8 +28,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}) - end + def self.new(cursor: nil, limit: nil, request_options: {}); end sig do override.returns( @@ -40,8 +39,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi index 279714f7..f468cf01 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi @@ -79,9 +79,7 @@ module Orb threshold:, expires_after: nil, expires_after_unit: nil - ) - end - + ); end sig do override .returns( @@ -97,8 +95,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's @@ -134,8 +131,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) - end + def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end sig do override @@ -148,8 +144,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end # The unit of expires_after. @@ -184,8 +179,7 @@ module Orb T::Array[Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi index 539d8e0e..ea1d478a 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi @@ -28,8 +28,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}) - end + def self.new(cursor: nil, limit: nil, request_options: {}); end sig do override.returns( @@ -40,8 +39,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi index db30a045..761fbaad 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi @@ -69,9 +69,7 @@ module Orb threshold:, expires_after: nil, expires_after_unit: nil - ) - end - + ); end sig do override .returns( @@ -87,8 +85,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's @@ -124,8 +121,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil) - end + def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end sig do override @@ -138,8 +134,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end # The unit of expires_after. @@ -158,8 +153,7 @@ module Orb override .returns(T::Array[Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/dimensional_price_group.rbi b/rbi/lib/orb/models/dimensional_price_group.rbi index 1a2836cc..9a7c1f22 100644 --- a/rbi/lib/orb/models/dimensional_price_group.rbi +++ b/rbi/lib/orb/models/dimensional_price_group.rbi @@ -68,8 +68,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/dimensional_price_group_create_params.rbi b/rbi/lib/orb/models/dimensional_price_group_create_params.rbi index 44cb89a1..9bbc836b 100644 --- a/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +++ b/rbi/lib/orb/models/dimensional_price_group_create_params.rbi @@ -43,9 +43,7 @@ module Orb external_dimensional_price_group_id: nil, metadata: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -59,8 +57,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/dimensional_price_group_list_params.rbi b/rbi/lib/orb/models/dimensional_price_group_list_params.rbi index b7f52c6e..c785bd6b 100644 --- a/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +++ b/rbi/lib/orb/models/dimensional_price_group_list_params.rbi @@ -26,14 +26,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}) - end + def self.new(cursor: nil, limit: nil, request_options: {}); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi b/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi index 4bd5f663..585e8756 100644 --- a/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +++ b/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/dimensional_price_groups.rbi b/rbi/lib/orb/models/dimensional_price_groups.rbi index 299029a4..8fd052e7 100644 --- a/rbi/lib/orb/models/dimensional_price_groups.rbi +++ b/rbi/lib/orb/models/dimensional_price_groups.rbi @@ -19,8 +19,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(data:, pagination_metadata:) - end + def self.new(data:, pagination_metadata:); end sig do override @@ -28,8 +27,7 @@ module Orb {data: T::Array[Orb::Models::DimensionalPriceGroup], pagination_metadata: Orb::Models::PaginationMetadata} ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi b/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi index e7d2e19d..00911238 100644 --- a/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +++ b/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi @@ -15,12 +15,10 @@ module Orb ) ).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/discount.rbi b/rbi/lib/orb/models/discount.rbi index 233055db..124b4aec 100644 --- a/rbi/lib/orb/models/discount.rbi +++ b/rbi/lib/orb/models/discount.rbi @@ -11,8 +11,7 @@ module Orb [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/evaluate_price_group.rbi b/rbi/lib/orb/models/evaluate_price_group.rbi index 783dcc63..19b59b06 100644 --- a/rbi/lib/orb/models/evaluate_price_group.rbi +++ b/rbi/lib/orb/models/evaluate_price_group.rbi @@ -19,8 +19,7 @@ module Orb params(amount: String, grouping_values: T::Array[T.any(String, Float, T::Boolean)], quantity: Float) .returns(T.attached_class) end - def self.new(amount:, grouping_values:, quantity:) - end + def self.new(amount:, grouping_values:, quantity:); end sig do override @@ -30,15 +29,13 @@ module Orb quantity: Float }) end - def to_hash - end + def to_hash; end module GroupingValue extend Orb::Internal::Type::Union sig { override.returns([String, Float, T::Boolean]) } - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/event_deprecate_params.rbi b/rbi/lib/orb/models/event_deprecate_params.rbi index c41ed2fa..d675e921 100644 --- a/rbi/lib/orb/models/event_deprecate_params.rbi +++ b/rbi/lib/orb/models/event_deprecate_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/event_deprecate_response.rbi b/rbi/lib/orb/models/event_deprecate_response.rbi index 9368dd78..191ad0bf 100644 --- a/rbi/lib/orb/models/event_deprecate_response.rbi +++ b/rbi/lib/orb/models/event_deprecate_response.rbi @@ -8,12 +8,10 @@ module Orb attr_accessor :deprecated sig { params(deprecated: String).returns(T.attached_class) } - def self.new(deprecated:) - end + def self.new(deprecated:); end sig { override.returns({deprecated: String}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/event_ingest_params.rbi b/rbi/lib/orb/models/event_ingest_params.rbi index 7145d6bd..53cc61dd 100644 --- a/rbi/lib/orb/models/event_ingest_params.rbi +++ b/rbi/lib/orb/models/event_ingest_params.rbi @@ -30,8 +30,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(events:, backfill_id: nil, debug: nil, request_options: {}) - end + def self.new(events:, backfill_id: nil, debug: nil, request_options: {}); end sig do override @@ -44,8 +43,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Event < Orb::Internal::Type::BaseModel # A name to meaningfully identify the action or event type. @@ -112,8 +110,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/event_ingest_response.rbi b/rbi/lib/orb/models/event_ingest_response.rbi index bb1acc3a..12ae1fb9 100644 --- a/rbi/lib/orb/models/event_ingest_response.rbi +++ b/rbi/lib/orb/models/event_ingest_response.rbi @@ -23,8 +23,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(validation_failed:, debug: nil) - end + def self.new(validation_failed:, debug: nil); end sig do override @@ -35,8 +34,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class ValidationFailed < Orb::Internal::Type::BaseModel # The passed idempotency_key corresponding to the validation_errors @@ -49,12 +47,10 @@ module Orb attr_accessor :validation_errors sig { params(idempotency_key: String, validation_errors: T::Array[String]).returns(T.attached_class) } - def self.new(idempotency_key:, validation_errors:) - end + def self.new(idempotency_key:, validation_errors:); end sig { override.returns({idempotency_key: String, validation_errors: T::Array[String]}) } - def to_hash - end + def to_hash; end end class Debug < Orb::Internal::Type::BaseModel @@ -67,12 +63,10 @@ module Orb # Optional debug information (only present when debug=true is passed to the # endpoint). Contains ingested and duplicate event idempotency keys. sig { params(duplicate: T::Array[String], ingested: T::Array[String]).returns(T.attached_class) } - def self.new(duplicate:, ingested:) - end + def self.new(duplicate:, ingested:); end sig { override.returns({duplicate: T::Array[String], ingested: T::Array[String]}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/event_search_params.rbi b/rbi/lib/orb/models/event_search_params.rbi index 3260636f..8f032ad8 100644 --- a/rbi/lib/orb/models/event_search_params.rbi +++ b/rbi/lib/orb/models/event_search_params.rbi @@ -32,8 +32,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}) - end + def self.new(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}); end sig do override @@ -46,8 +45,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/event_search_response.rbi b/rbi/lib/orb/models/event_search_response.rbi index 13e00ff1..1964ffdd 100644 --- a/rbi/lib/orb/models/event_search_response.rbi +++ b/rbi/lib/orb/models/event_search_response.rbi @@ -10,12 +10,10 @@ module Orb params(data: T::Array[T.any(Orb::Models::EventSearchResponse::Data, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(data:) - end + def self.new(data:); end sig { override.returns({data: T::Array[Orb::Models::EventSearchResponse::Data]}) } - def to_hash - end + def to_hash; end class Data < Orb::Internal::Type::BaseModel # A unique value, generated by the client, that is used to de-duplicate events. @@ -92,8 +90,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/event_update_params.rbi b/rbi/lib/orb/models/event_update_params.rbi index 75521931..7483b6e1 100644 --- a/rbi/lib/orb/models/event_update_params.rbi +++ b/rbi/lib/orb/models/event_update_params.rbi @@ -64,8 +64,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/event_update_response.rbi b/rbi/lib/orb/models/event_update_response.rbi index dfe85605..992924be 100644 --- a/rbi/lib/orb/models/event_update_response.rbi +++ b/rbi/lib/orb/models/event_update_response.rbi @@ -8,12 +8,10 @@ module Orb attr_accessor :amended sig { params(amended: String).returns(T.attached_class) } - def self.new(amended:) - end + def self.new(amended:); end sig { override.returns({amended: String}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/events/backfill_close_params.rbi b/rbi/lib/orb/models/events/backfill_close_params.rbi index b1898cb1..63384634 100644 --- a/rbi/lib/orb/models/events/backfill_close_params.rbi +++ b/rbi/lib/orb/models/events/backfill_close_params.rbi @@ -15,12 +15,10 @@ module Orb ) ).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/events/backfill_close_response.rbi b/rbi/lib/orb/models/events/backfill_close_response.rbi index 8a6a2f36..ee975037 100644 --- a/rbi/lib/orb/models/events/backfill_close_response.rbi +++ b/rbi/lib/orb/models/events/backfill_close_response.rbi @@ -80,9 +80,7 @@ module Orb timeframe_end:, timeframe_start:, deprecation_filter: nil - ) - end - + ); end sig do override .returns( @@ -101,8 +99,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The status of the backfill. module Status @@ -118,8 +115,7 @@ module Orb REVERTED = T.let(:reverted, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/events/backfill_create_params.rbi b/rbi/lib/orb/models/events/backfill_create_params.rbi index 1bc97d77..c8e8756a 100644 --- a/rbi/lib/orb/models/events/backfill_create_params.rbi +++ b/rbi/lib/orb/models/events/backfill_create_params.rbi @@ -71,9 +71,7 @@ module Orb external_customer_id: nil, replace_existing_events: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -89,8 +87,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/events/backfill_create_response.rbi b/rbi/lib/orb/models/events/backfill_create_response.rbi index 7b1a745f..dd00f98a 100644 --- a/rbi/lib/orb/models/events/backfill_create_response.rbi +++ b/rbi/lib/orb/models/events/backfill_create_response.rbi @@ -80,9 +80,7 @@ module Orb timeframe_end:, timeframe_start:, deprecation_filter: nil - ) - end - + ); end sig do override .returns( @@ -101,8 +99,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The status of the backfill. module Status @@ -119,8 +116,7 @@ module Orb REVERTED = T.let(:reverted, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/events/backfill_fetch_params.rbi b/rbi/lib/orb/models/events/backfill_fetch_params.rbi index 378a1483..43a1cc64 100644 --- a/rbi/lib/orb/models/events/backfill_fetch_params.rbi +++ b/rbi/lib/orb/models/events/backfill_fetch_params.rbi @@ -15,12 +15,10 @@ module Orb ) ).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/events/backfill_fetch_response.rbi b/rbi/lib/orb/models/events/backfill_fetch_response.rbi index b5849477..04dd3bde 100644 --- a/rbi/lib/orb/models/events/backfill_fetch_response.rbi +++ b/rbi/lib/orb/models/events/backfill_fetch_response.rbi @@ -80,9 +80,7 @@ module Orb timeframe_end:, timeframe_start:, deprecation_filter: nil - ) - end - + ); end sig do override .returns( @@ -101,8 +99,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The status of the backfill. module Status @@ -118,8 +115,7 @@ module Orb REVERTED = T.let(:reverted, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/events/backfill_list_params.rbi b/rbi/lib/orb/models/events/backfill_list_params.rbi index 621ee95a..ebde71a4 100644 --- a/rbi/lib/orb/models/events/backfill_list_params.rbi +++ b/rbi/lib/orb/models/events/backfill_list_params.rbi @@ -27,14 +27,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}) - end + def self.new(cursor: nil, limit: nil, request_options: {}); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/events/backfill_list_response.rbi b/rbi/lib/orb/models/events/backfill_list_response.rbi index 8a03fb10..569ca45e 100644 --- a/rbi/lib/orb/models/events/backfill_list_response.rbi +++ b/rbi/lib/orb/models/events/backfill_list_response.rbi @@ -80,9 +80,7 @@ module Orb timeframe_end:, timeframe_start:, deprecation_filter: nil - ) - end - + ); end sig do override .returns( @@ -101,8 +99,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The status of the backfill. module Status @@ -118,8 +115,7 @@ module Orb REVERTED = T.let(:reverted, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/events/backfill_revert_params.rbi b/rbi/lib/orb/models/events/backfill_revert_params.rbi index cc7763f1..7c02baa6 100644 --- a/rbi/lib/orb/models/events/backfill_revert_params.rbi +++ b/rbi/lib/orb/models/events/backfill_revert_params.rbi @@ -15,12 +15,10 @@ module Orb ) ).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/events/backfill_revert_response.rbi b/rbi/lib/orb/models/events/backfill_revert_response.rbi index aede931b..d85a97bc 100644 --- a/rbi/lib/orb/models/events/backfill_revert_response.rbi +++ b/rbi/lib/orb/models/events/backfill_revert_response.rbi @@ -80,9 +80,7 @@ module Orb timeframe_end:, timeframe_start:, deprecation_filter: nil - ) - end - + ); end sig do override .returns( @@ -101,8 +99,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The status of the backfill. module Status @@ -119,8 +116,7 @@ module Orb REVERTED = T.let(:reverted, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/events/event_volumes.rbi b/rbi/lib/orb/models/events/event_volumes.rbi index 49dbac7a..3e39437c 100644 --- a/rbi/lib/orb/models/events/event_volumes.rbi +++ b/rbi/lib/orb/models/events/event_volumes.rbi @@ -11,12 +11,10 @@ module Orb params(data: T::Array[T.any(Orb::Models::Events::EventVolumes::Data, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(data:) - end + def self.new(data:); end sig { override.returns({data: T::Array[Orb::Models::Events::EventVolumes::Data]}) } - def to_hash - end + def to_hash; end class Data < Orb::Internal::Type::BaseModel # The number of events ingested with a timestamp between the timeframe @@ -32,12 +30,10 @@ module Orb # An EventVolume contains the event volume ingested in an hourly window. The # timestamp used for the aggregation is the `timestamp` datetime field on events. sig { params(count: Integer, timeframe_end: Time, timeframe_start: Time).returns(T.attached_class) } - def self.new(count:, timeframe_end:, timeframe_start:) - end + def self.new(count:, timeframe_end:, timeframe_start:); end sig { override.returns({count: Integer, timeframe_end: Time, timeframe_start: Time}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/events/volume_list_params.rbi b/rbi/lib/orb/models/events/volume_list_params.rbi index 1a534c27..78287890 100644 --- a/rbi/lib/orb/models/events/volume_list_params.rbi +++ b/rbi/lib/orb/models/events/volume_list_params.rbi @@ -46,8 +46,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}) - end + def self.new(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}); end sig do override @@ -61,8 +60,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice.rbi b/rbi/lib/orb/models/invoice.rbi index 6469e3c8..baaf8166 100644 --- a/rbi/lib/orb/models/invoice.rbi +++ b/rbi/lib/orb/models/invoice.rbi @@ -155,7 +155,9 @@ module Orb sig { returns(T.nilable(Orb::Models::Invoice::CustomerTaxID)) } attr_reader :customer_tax_id - sig { params(customer_tax_id: T.nilable(T.any(Orb::Models::Invoice::CustomerTaxID, Orb::Internal::AnyHash))).void } + sig do + params(customer_tax_id: T.nilable(T.any(Orb::Models::Invoice::CustomerTaxID, Orb::Internal::AnyHash))).void + end attr_writer :customer_tax_id # This field is deprecated in favor of `discounts`. If a `discounts` list is @@ -333,12 +335,12 @@ module Orb customer_tax_id: T.nilable(T.any(Orb::Models::Invoice::CustomerTaxID, Orb::Internal::AnyHash)), discount: T.anything, discounts: T::Array[ - T.any( - Orb::Models::PercentageDiscount, - Orb::Internal::AnyHash, - Orb::Models::AmountDiscount, - Orb::Models::TrialDiscount - ) + T.any( + Orb::Models::PercentageDiscount, + Orb::Internal::AnyHash, + Orb::Models::AmountDiscount, + Orb::Models::TrialDiscount + ) ], due_date: T.nilable(Time), eligible_to_issue_at: T.nilable(Time), @@ -414,9 +416,7 @@ module Orb total:, voided_at:, will_auto_issue: - ) - end - + ); end sig do override .returns( @@ -465,8 +465,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AutoCollection < Orb::Internal::Type::BaseModel # True only if auto-collection is enabled for this invoice. @@ -501,8 +500,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:) - end + def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:); end sig do override @@ -515,8 +513,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class BillingAddress < Orb::Internal::Type::BaseModel @@ -549,8 +546,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city:, country:, line1:, line2:, postal_code:, state:) - end + def self.new(city:, country:, line1:, line2:, postal_code:, state:); end sig do override @@ -565,8 +561,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class CreditNote < Orb::Internal::Type::BaseModel @@ -606,8 +601,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:) - end + def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:); end sig do override @@ -623,8 +617,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -635,12 +628,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel @@ -724,9 +715,7 @@ module Orb invoice:, starting_balance:, type: - ) - end - + ); end sig do override .returns( @@ -744,8 +733,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Action extend Orb::Internal::Type::Enum @@ -774,8 +762,7 @@ module Orb T.let(:external_payment, Orb::Models::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditNote < Orb::Internal::Type::BaseModel @@ -784,12 +771,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class Invoice < Orb::Internal::Type::BaseModel @@ -798,12 +783,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end module Type @@ -817,8 +800,7 @@ module Orb DECREMENT = T.let(:decrement, Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end @@ -945,8 +927,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(country:, type:, value:) - end + def self.new(country:, type:, value:); end sig do override @@ -958,8 +939,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Country extend Orb::Internal::Type::Enum @@ -1048,8 +1028,7 @@ module Orb ZA = T.let(:ZA, Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol]) } - def self.values - end + def self.values; end end module Type @@ -1132,8 +1111,7 @@ module Orb ZA_VAT = T.let(:za_vat, Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end @@ -1148,8 +1126,7 @@ module Orb ONE_OFF = T.let(:one_off, Orb::Models::Invoice::InvoiceSource::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Invoice::InvoiceSource::TaggedSymbol]) } - def self.values - end + def self.values; end end class LineItem < Orb::Internal::Type::BaseModel @@ -1168,13 +1145,13 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment - ) + T.any( + Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment + ) ] ) end @@ -1308,11 +1285,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, - Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, - Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem - ) + T.any( + Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, + Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, + Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem + ) ] ) end @@ -1336,14 +1313,14 @@ module Orb id: String, adjusted_subtotal: String, adjustments: T::Array[ - T.any( - Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, - Orb::Internal::AnyHash, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment - ) + T.any( + Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, + Orb::Internal::AnyHash, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment + ) ], amount: String, credits_applied: String, @@ -1401,12 +1378,12 @@ module Orb quantity: Float, start_date: Time, sub_line_items: T::Array[ - T.any( - Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, - Orb::Internal::AnyHash, - Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, - Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem - ) + T.any( + Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, + Orb::Internal::AnyHash, + Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, + Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem + ) ], subtotal: String, tax_amounts: T::Array[T.any(Orb::Models::Invoice::LineItem::TaxAmount, Orb::Internal::AnyHash)], @@ -1437,9 +1414,7 @@ module Orb subtotal:, tax_amounts:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1447,13 +1422,13 @@ module Orb id: String, adjusted_subtotal: String, adjustments: T::Array[ - T.any( - Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, - Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment - ) + T.any( + Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, + Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment + ) ], amount: String, credits_applied: String, @@ -1509,11 +1484,11 @@ module Orb quantity: Float, start_date: Time, sub_line_items: T::Array[ - T.any( - Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, - Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, - Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem - ) + T.any( + Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, + Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, + Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem + ) ], subtotal: String, tax_amounts: T::Array[Orb::Models::Invoice::LineItem::TaxAmount], @@ -1521,8 +1496,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -1576,9 +1550,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -1593,8 +1565,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -1646,9 +1617,7 @@ module Orb is_invoice_level:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -1663,8 +1632,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -1716,9 +1684,7 @@ module Orb percentage_discount:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -1733,8 +1699,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -1792,9 +1757,7 @@ module Orb minimum_amount:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -1810,8 +1773,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -1863,9 +1825,7 @@ module Orb maximum_amount:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -1880,8 +1840,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -1890,8 +1849,7 @@ module Orb [Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::Invoice::LineItem::Adjustment::MonetaryMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end class Maximum < Orb::Internal::Type::BaseModel @@ -1908,12 +1866,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -1930,12 +1886,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module SubLineItem @@ -1998,8 +1952,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix) - end + def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end sig do override @@ -2014,8 +1967,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Grouping < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -2026,12 +1978,10 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:) - end + def self.new(key:, value:); end sig { override.returns({key: String, value: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -2040,12 +1990,10 @@ module Orb attr_accessor :dimension_values sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) } - def self.new(dimension_values:) - end + def self.new(dimension_values:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) } - def to_hash - end + def to_hash; end end end @@ -2100,8 +2048,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier) - end + def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end sig do override @@ -2116,8 +2063,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Grouping < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -2128,12 +2074,10 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:) - end + def self.new(key:, value:); end sig { override.returns({key: String, value: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class TierConfig < Orb::Internal::Type::BaseModel @@ -2153,12 +2097,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(first_unit:, last_unit:, unit_amount:) - end + def self.new(first_unit:, last_unit:, unit_amount:); end sig { override.returns({first_unit: Float, last_unit: T.nilable(Float), unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -2201,8 +2143,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, type: :"'null'") - end + def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end sig do override @@ -2216,8 +2157,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Grouping < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -2228,12 +2168,10 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:) - end + def self.new(key:, value:); end sig { override.returns({key: String, value: T.nilable(String)}) } - def to_hash - end + def to_hash; end end end @@ -2243,8 +2181,7 @@ module Orb [Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem, Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem] ) end - def self.variants - end + def self.variants; end end class TaxAmount < Orb::Internal::Type::BaseModel @@ -2264,8 +2201,7 @@ module Orb params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String)) .returns(T.attached_class) end - def self.new(amount:, tax_rate_description:, tax_rate_percentage:) - end + def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end sig do override.returns( @@ -2276,8 +2212,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -2294,12 +2229,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -2315,12 +2248,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end class PaymentAttempt < Orb::Internal::Type::BaseModel @@ -2359,8 +2290,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:) - end + def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:); end sig do override @@ -2375,8 +2305,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The payment provider that attempted to collect the payment. module PaymentProvider @@ -2389,8 +2318,7 @@ module Orb STRIPE = T.let(:stripe, Orb::Models::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol]) } - def self.values - end + def self.values; end end end @@ -2424,8 +2352,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city:, country:, line1:, line2:, postal_code:, state:) - end + def self.new(city:, country:, line1:, line2:, postal_code:, state:); end sig do override @@ -2440,8 +2367,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end module Status @@ -2457,8 +2383,7 @@ module Orb DRAFT = T.let(:draft, Orb::Models::Invoice::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Invoice::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class Subscription < Orb::Internal::Type::BaseModel @@ -2466,12 +2391,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_create_params.rbi b/rbi/lib/orb/models/invoice_create_params.rbi index 136edce1..1cd58e8e 100644 --- a/rbi/lib/orb/models/invoice_create_params.rbi +++ b/rbi/lib/orb/models/invoice_create_params.rbi @@ -105,9 +105,7 @@ module Orb metadata: nil, will_auto_issue: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -133,8 +131,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class LineItem < Orb::Internal::Type::BaseModel # A date string to specify the line item's end date in the customer's timezone. @@ -180,8 +177,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:) - end + def self.new(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:); end sig do override @@ -197,8 +193,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module ModelType extend Orb::Internal::Type::Enum @@ -210,8 +205,7 @@ module Orb UNIT = T.let(:unit, Orb::Models::InvoiceCreateParams::LineItem::ModelType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::InvoiceCreateParams::LineItem::ModelType::TaggedSymbol]) } - def self.values - end + def self.values; end end class UnitConfig < Orb::Internal::Type::BaseModel @@ -220,12 +214,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:) - end + def self.new(unit_amount:); end sig { override.returns({unit_amount: String}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_fetch_params.rbi b/rbi/lib/orb/models/invoice_fetch_params.rbi index 3c9f22ea..a6d1fed5 100644 --- a/rbi/lib/orb/models/invoice_fetch_params.rbi +++ b/rbi/lib/orb/models/invoice_fetch_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi b/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi index b31c1a42..8836f3a4 100644 --- a/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +++ b/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi @@ -13,12 +13,10 @@ module Orb params(subscription_id: String, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(subscription_id:, request_options: {}) - end + def self.new(subscription_id:, request_options: {}); end sig { override.returns({subscription_id: String, request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi b/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi index 38042902..2b3d0bd0 100644 --- a/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +++ b/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi @@ -357,12 +357,12 @@ module Orb customer_tax_id: T.nilable(T.any(Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, Orb::Internal::AnyHash)), discount: T.anything, discounts: T::Array[ - T.any( - Orb::Models::PercentageDiscount, - Orb::Internal::AnyHash, - Orb::Models::AmountDiscount, - Orb::Models::TrialDiscount - ) + T.any( + Orb::Models::PercentageDiscount, + Orb::Internal::AnyHash, + Orb::Models::AmountDiscount, + Orb::Models::TrialDiscount + ) ], due_date: T.nilable(Time), eligible_to_issue_at: T.nilable(Time), @@ -438,9 +438,7 @@ module Orb total:, voided_at:, will_auto_issue: - ) - end - + ); end sig do override .returns( @@ -489,8 +487,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AutoCollection < Orb::Internal::Type::BaseModel # True only if auto-collection is enabled for this invoice. @@ -525,8 +522,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:) - end + def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:); end sig do override @@ -539,8 +535,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class BillingAddress < Orb::Internal::Type::BaseModel @@ -573,8 +568,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city:, country:, line1:, line2:, postal_code:, state:) - end + def self.new(city:, country:, line1:, line2:, postal_code:, state:); end sig do override @@ -589,8 +583,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class CreditNote < Orb::Internal::Type::BaseModel @@ -630,8 +623,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:) - end + def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:); end sig do override @@ -647,8 +639,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Customer < Orb::Internal::Type::BaseModel @@ -659,12 +650,10 @@ module Orb attr_accessor :external_customer_id sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) } - def self.new(id:, external_customer_id:) - end + def self.new(id:, external_customer_id:); end sig { override.returns({id: String, external_customer_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel @@ -768,9 +757,7 @@ module Orb invoice:, starting_balance:, type: - ) - end - + ); end sig do override .returns( @@ -788,8 +775,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Action extend Orb::Internal::Type::Enum @@ -857,8 +843,7 @@ module Orb T::Array[Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action::TaggedSymbol] ) end - def self.values - end + def self.values; end end class CreditNote < Orb::Internal::Type::BaseModel @@ -867,12 +852,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class Invoice < Orb::Internal::Type::BaseModel @@ -881,12 +864,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end module Type @@ -920,8 +901,7 @@ module Orb T::Array[Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -1048,8 +1028,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(country:, type:, value:) - end + def self.new(country:, type:, value:); end sig do override @@ -1061,8 +1040,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Country extend Orb::Internal::Type::Enum @@ -1154,8 +1132,7 @@ module Orb sig do override.returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol]) end - def self.values - end + def self.values; end end module Type @@ -1244,8 +1221,7 @@ module Orb ZA_VAT = T.let(:za_vat, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol]) } - def self.values - end + def self.values; end end end @@ -1262,8 +1238,7 @@ module Orb ONE_OFF = T.let(:one_off, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol]) } - def self.values - end + def self.values; end end class LineItem < Orb::Internal::Type::BaseModel @@ -1282,13 +1257,13 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment - ) + T.any( + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment + ) ] ) end @@ -1432,11 +1407,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem - ) + T.any( + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem + ) ] ) end @@ -1460,14 +1435,14 @@ module Orb id: String, adjusted_subtotal: String, adjustments: T::Array[ - T.any( - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, - Orb::Internal::AnyHash, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment - ) + T.any( + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, + Orb::Internal::AnyHash, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment + ) ], amount: String, credits_applied: String, @@ -1525,12 +1500,12 @@ module Orb quantity: Float, start_date: Time, sub_line_items: T::Array[ - T.any( - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, - Orb::Internal::AnyHash, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem - ) + T.any( + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, + Orb::Internal::AnyHash, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem + ) ], subtotal: String, tax_amounts: T::Array[T.any(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount, Orb::Internal::AnyHash)], @@ -1561,9 +1536,7 @@ module Orb subtotal:, tax_amounts:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1571,13 +1544,13 @@ module Orb id: String, adjusted_subtotal: String, adjustments: T::Array[ - T.any( - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment - ) + T.any( + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment + ) ], amount: String, credits_applied: String, @@ -1633,11 +1606,11 @@ module Orb quantity: Float, start_date: Time, sub_line_items: T::Array[ - T.any( - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, - Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem - ) + T.any( + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, + Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem + ) ], subtotal: String, tax_amounts: T::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount], @@ -1645,8 +1618,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -1700,9 +1672,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -1717,8 +1687,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -1770,9 +1739,7 @@ module Orb is_invoice_level:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -1787,8 +1754,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -1840,9 +1806,7 @@ module Orb percentage_discount:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -1857,8 +1821,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -1916,9 +1879,7 @@ module Orb minimum_amount:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -1934,8 +1895,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -1987,9 +1947,7 @@ module Orb maximum_amount:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -2004,8 +1962,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -2014,8 +1971,7 @@ module Orb [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end class Maximum < Orb::Internal::Type::BaseModel @@ -2032,12 +1988,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -2054,12 +2008,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module SubLineItem @@ -2132,8 +2084,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix) - end + def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end sig do override @@ -2148,8 +2099,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Grouping < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -2160,12 +2110,10 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:) - end + def self.new(key:, value:); end sig { override.returns({key: String, value: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -2174,12 +2122,10 @@ module Orb attr_accessor :dimension_values sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) } - def self.new(dimension_values:) - end + def self.new(dimension_values:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) } - def to_hash - end + def to_hash; end end end @@ -2250,8 +2196,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier) - end + def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end sig do override @@ -2266,8 +2211,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Grouping < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -2278,12 +2222,10 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:) - end + def self.new(key:, value:); end sig { override.returns({key: String, value: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class TierConfig < Orb::Internal::Type::BaseModel @@ -2303,12 +2245,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(first_unit:, last_unit:, unit_amount:) - end + def self.new(first_unit:, last_unit:, unit_amount:); end sig { override.returns({first_unit: Float, last_unit: T.nilable(Float), unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -2361,8 +2301,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, type: :"'null'") - end + def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end sig do override @@ -2376,8 +2315,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Grouping < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -2388,12 +2326,10 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:) - end + def self.new(key:, value:); end sig { override.returns({key: String, value: T.nilable(String)}) } - def to_hash - end + def to_hash; end end end @@ -2403,8 +2339,7 @@ module Orb [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem] ) end - def self.variants - end + def self.variants; end end class TaxAmount < Orb::Internal::Type::BaseModel @@ -2424,8 +2359,7 @@ module Orb params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String)) .returns(T.attached_class) end - def self.new(amount:, tax_rate_description:, tax_rate_percentage:) - end + def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end sig do override.returns( @@ -2436,8 +2370,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -2454,12 +2387,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -2475,12 +2406,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end class PaymentAttempt < Orb::Internal::Type::BaseModel @@ -2523,8 +2452,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:) - end + def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:); end sig do override @@ -2539,8 +2467,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The payment provider that attempted to collect the payment. module PaymentProvider @@ -2566,8 +2493,7 @@ module Orb T::Array[Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -2601,8 +2527,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(city:, country:, line1:, line2:, postal_code:, state:) - end + def self.new(city:, country:, line1:, line2:, postal_code:, state:); end sig do override @@ -2617,8 +2542,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end module Status @@ -2635,8 +2559,7 @@ module Orb DRAFT = T.let(:draft, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class Subscription < Orb::Internal::Type::BaseModel @@ -2644,12 +2567,10 @@ module Orb attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_issue_params.rbi b/rbi/lib/orb/models/invoice_issue_params.rbi index 8976872a..31558a19 100644 --- a/rbi/lib/orb/models/invoice_issue_params.rbi +++ b/rbi/lib/orb/models/invoice_issue_params.rbi @@ -21,12 +21,10 @@ module Orb params(synchronous: T::Boolean, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(synchronous: nil, request_options: {}) - end + def self.new(synchronous: nil, request_options: {}); end sig { override.returns({synchronous: T::Boolean, request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_level_discount.rbi b/rbi/lib/orb/models/invoice_level_discount.rbi index 848c2749..358c926d 100644 --- a/rbi/lib/orb/models/invoice_level_discount.rbi +++ b/rbi/lib/orb/models/invoice_level_discount.rbi @@ -9,8 +9,7 @@ module Orb override .returns([Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount]) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/invoice_line_item_create_params.rbi b/rbi/lib/orb/models/invoice_line_item_create_params.rbi index 73cb9be3..1e0ed8f0 100644 --- a/rbi/lib/orb/models/invoice_line_item_create_params.rbi +++ b/rbi/lib/orb/models/invoice_line_item_create_params.rbi @@ -43,8 +43,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {}) - end + def self.new(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {}); end sig do override @@ -60,8 +59,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_line_item_create_response.rbi b/rbi/lib/orb/models/invoice_line_item_create_response.rbi index 719f8ad4..bf2790fa 100644 --- a/rbi/lib/orb/models/invoice_line_item_create_response.rbi +++ b/rbi/lib/orb/models/invoice_line_item_create_response.rbi @@ -18,13 +18,13 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment - ) + T.any( + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment + ) ] ) end @@ -168,11 +168,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, - Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, - Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem - ) + T.any( + Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, + Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, + Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem + ) ] ) end @@ -196,14 +196,14 @@ module Orb id: String, adjusted_subtotal: String, adjustments: T::Array[ - T.any( - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, - Orb::Internal::AnyHash, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment - ) + T.any( + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, + Orb::Internal::AnyHash, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment + ) ], amount: String, credits_applied: String, @@ -261,12 +261,12 @@ module Orb quantity: Float, start_date: Time, sub_line_items: T::Array[ - T.any( - Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, - Orb::Internal::AnyHash, - Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, - Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem - ) + T.any( + Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, + Orb::Internal::AnyHash, + Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, + Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem + ) ], subtotal: String, tax_amounts: T::Array[T.any(Orb::Models::InvoiceLineItemCreateResponse::TaxAmount, Orb::Internal::AnyHash)], @@ -297,9 +297,7 @@ module Orb subtotal:, tax_amounts:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -307,13 +305,13 @@ module Orb id: String, adjusted_subtotal: String, adjustments: T::Array[ - T.any( - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, - Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment - ) + T.any( + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, + Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment + ) ], amount: String, credits_applied: String, @@ -369,11 +367,11 @@ module Orb quantity: Float, start_date: Time, sub_line_items: T::Array[ - T.any( - Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, - Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, - Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem - ) + T.any( + Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, + Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, + Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem + ) ], subtotal: String, tax_amounts: T::Array[Orb::Models::InvoiceLineItemCreateResponse::TaxAmount], @@ -381,8 +379,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -436,9 +433,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -453,8 +448,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -506,9 +500,7 @@ module Orb is_invoice_level:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -523,8 +515,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -576,9 +567,7 @@ module Orb percentage_discount:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -593,8 +582,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -652,9 +640,7 @@ module Orb minimum_amount:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -670,8 +656,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -723,9 +708,7 @@ module Orb maximum_amount:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -740,8 +723,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -750,8 +732,7 @@ module Orb [Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end class Maximum < Orb::Internal::Type::BaseModel @@ -768,12 +749,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -790,12 +769,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module SubLineItem @@ -864,8 +841,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix) - end + def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end sig do override @@ -880,8 +856,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Grouping < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -892,12 +867,10 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:) - end + def self.new(key:, value:); end sig { override.returns({key: String, value: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -906,12 +879,10 @@ module Orb attr_accessor :dimension_values sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) } - def self.new(dimension_values:) - end + def self.new(dimension_values:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) } - def to_hash - end + def to_hash; end end end @@ -978,8 +949,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier) - end + def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end sig do override @@ -994,8 +964,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Grouping < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1006,12 +975,10 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:) - end + def self.new(key:, value:); end sig { override.returns({key: String, value: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class TierConfig < Orb::Internal::Type::BaseModel @@ -1031,12 +998,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(first_unit:, last_unit:, unit_amount:) - end + def self.new(first_unit:, last_unit:, unit_amount:); end sig { override.returns({first_unit: Float, last_unit: T.nilable(Float), unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -1085,8 +1050,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, grouping:, name:, quantity:, type: :"'null'") - end + def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end sig do override @@ -1100,8 +1064,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Grouping < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -1112,12 +1075,10 @@ module Orb attr_accessor :value sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) } - def self.new(key:, value:) - end + def self.new(key:, value:); end sig { override.returns({key: String, value: T.nilable(String)}) } - def to_hash - end + def to_hash; end end end @@ -1127,8 +1088,7 @@ module Orb [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem] ) end - def self.variants - end + def self.variants; end end class TaxAmount < Orb::Internal::Type::BaseModel @@ -1148,8 +1108,7 @@ module Orb params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String)) .returns(T.attached_class) end - def self.new(amount:, tax_rate_description:, tax_rate_percentage:) - end + def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end sig do override.returns( @@ -1160,8 +1119,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_list_params.rbi b/rbi/lib/orb/models/invoice_list_params.rbi index fdd0175c..1e6c59aa 100644 --- a/rbi/lib/orb/models/invoice_list_params.rbi +++ b/rbi/lib/orb/models/invoice_list_params.rbi @@ -119,9 +119,7 @@ module Orb status: nil, subscription_id: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -149,8 +147,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DateType extend Orb::Internal::Type::Enum @@ -162,8 +159,7 @@ module Orb INVOICE_DATE = T.let(:invoice_date, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::InvoiceListParams::DateType::TaggedSymbol]) } - def self.values - end + def self.values; end end module Status @@ -179,8 +175,7 @@ module Orb VOID = T.let(:void, Orb::Models::InvoiceListParams::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::InvoiceListParams::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/invoice_mark_paid_params.rbi b/rbi/lib/orb/models/invoice_mark_paid_params.rbi index 6f496d08..207edef4 100644 --- a/rbi/lib/orb/models/invoice_mark_paid_params.rbi +++ b/rbi/lib/orb/models/invoice_mark_paid_params.rbi @@ -27,8 +27,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(payment_received_date:, external_id: nil, notes: nil, request_options: {}) - end + def self.new(payment_received_date:, external_id: nil, notes: nil, request_options: {}); end sig do override @@ -41,8 +40,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_pay_params.rbi b/rbi/lib/orb/models/invoice_pay_params.rbi index a6978b72..d38cfa1d 100644 --- a/rbi/lib/orb/models/invoice_pay_params.rbi +++ b/rbi/lib/orb/models/invoice_pay_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_update_params.rbi b/rbi/lib/orb/models/invoice_update_params.rbi index 9bfd06e9..5b006f69 100644 --- a/rbi/lib/orb/models/invoice_update_params.rbi +++ b/rbi/lib/orb/models/invoice_update_params.rbi @@ -19,8 +19,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(metadata: nil, request_options: {}) - end + def self.new(metadata: nil, request_options: {}); end sig do override @@ -29,8 +28,7 @@ module Orb request_options: Orb::RequestOptions }) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/invoice_void_params.rbi b/rbi/lib/orb/models/invoice_void_params.rbi index 3bc974d9..33cc29cd 100644 --- a/rbi/lib/orb/models/invoice_void_params.rbi +++ b/rbi/lib/orb/models/invoice_void_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/item.rbi b/rbi/lib/orb/models/item.rbi index b96d80b7..4bd0d91f 100644 --- a/rbi/lib/orb/models/item.rbi +++ b/rbi/lib/orb/models/item.rbi @@ -27,8 +27,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, created_at:, external_connections:, name:) - end + def self.new(id:, created_at:, external_connections:, name:); end sig do override @@ -41,8 +40,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class ExternalConnection < Orb::Internal::Type::BaseModel sig { returns(Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) } @@ -58,8 +56,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(external_connection_name:, external_entity_id:) - end + def self.new(external_connection_name:, external_entity_id:); end sig do override @@ -70,8 +67,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module ExternalConnectionName extend Orb::Internal::Type::Enum @@ -92,8 +88,7 @@ module Orb ANROK = T.let(:anrok, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/item_create_params.rbi b/rbi/lib/orb/models/item_create_params.rbi index fec615d0..ed4fec95 100644 --- a/rbi/lib/orb/models/item_create_params.rbi +++ b/rbi/lib/orb/models/item_create_params.rbi @@ -14,12 +14,10 @@ module Orb params(name: String, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(name:, request_options: {}) - end + def self.new(name:, request_options: {}); end sig { override.returns({name: String, request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/item_fetch_params.rbi b/rbi/lib/orb/models/item_fetch_params.rbi index 29b59a2e..9c251146 100644 --- a/rbi/lib/orb/models/item_fetch_params.rbi +++ b/rbi/lib/orb/models/item_fetch_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/item_list_params.rbi b/rbi/lib/orb/models/item_list_params.rbi index 6275fd30..4c6a667f 100644 --- a/rbi/lib/orb/models/item_list_params.rbi +++ b/rbi/lib/orb/models/item_list_params.rbi @@ -26,14 +26,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}) - end + def self.new(cursor: nil, limit: nil, request_options: {}); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/item_update_params.rbi b/rbi/lib/orb/models/item_update_params.rbi index 48e81fde..4daba38a 100644 --- a/rbi/lib/orb/models/item_update_params.rbi +++ b/rbi/lib/orb/models/item_update_params.rbi @@ -20,8 +20,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(external_connections: nil, name: nil, request_options: {}) - end + def self.new(external_connections: nil, name: nil, request_options: {}); end sig do override @@ -33,8 +32,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class ExternalConnection < Orb::Internal::Type::BaseModel sig { returns(Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::OrSymbol) } @@ -50,8 +48,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(external_connection_name:, external_entity_id:) - end + def self.new(external_connection_name:, external_entity_id:); end sig do override @@ -62,8 +59,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module ExternalConnectionName extend Orb::Internal::Type::Enum @@ -104,8 +100,7 @@ module Orb override .returns(T::Array[Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol]) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/metric_create_params.rbi b/rbi/lib/orb/models/metric_create_params.rbi index dd7fc43d..8e3cdf50 100644 --- a/rbi/lib/orb/models/metric_create_params.rbi +++ b/rbi/lib/orb/models/metric_create_params.rbi @@ -39,8 +39,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(description:, item_id:, name:, sql:, metadata: nil, request_options: {}) - end + def self.new(description:, item_id:, name:, sql:, metadata: nil, request_options: {}); end sig do override @@ -55,8 +54,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/metric_fetch_params.rbi b/rbi/lib/orb/models/metric_fetch_params.rbi index cc305e2b..a5e618d5 100644 --- a/rbi/lib/orb/models/metric_fetch_params.rbi +++ b/rbi/lib/orb/models/metric_fetch_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/metric_list_params.rbi b/rbi/lib/orb/models/metric_list_params.rbi index e9033e02..31dd02f1 100644 --- a/rbi/lib/orb/models/metric_list_params.rbi +++ b/rbi/lib/orb/models/metric_list_params.rbi @@ -50,9 +50,7 @@ module Orb cursor: nil, limit: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -67,8 +65,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/metric_update_params.rbi b/rbi/lib/orb/models/metric_update_params.rbi index 639ce102..ecea21a4 100644 --- a/rbi/lib/orb/models/metric_update_params.rbi +++ b/rbi/lib/orb/models/metric_update_params.rbi @@ -19,8 +19,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(metadata: nil, request_options: {}) - end + def self.new(metadata: nil, request_options: {}); end sig do override @@ -29,8 +28,7 @@ module Orb request_options: Orb::RequestOptions }) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/pagination_metadata.rbi b/rbi/lib/orb/models/pagination_metadata.rbi index c2b91fc9..8f9b010e 100644 --- a/rbi/lib/orb/models/pagination_metadata.rbi +++ b/rbi/lib/orb/models/pagination_metadata.rbi @@ -10,12 +10,10 @@ module Orb attr_accessor :next_cursor sig { params(has_more: T::Boolean, next_cursor: T.nilable(String)).returns(T.attached_class) } - def self.new(has_more:, next_cursor:) - end + def self.new(has_more:, next_cursor:); end sig { override.returns({has_more: T::Boolean, next_cursor: T.nilable(String)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/percentage_discount.rbi b/rbi/lib/orb/models/percentage_discount.rbi index f716d3e4..46938aa4 100644 --- a/rbi/lib/orb/models/percentage_discount.rbi +++ b/rbi/lib/orb/models/percentage_discount.rbi @@ -28,8 +28,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(applies_to_price_ids:, discount_type:, percentage_discount:, reason: nil) - end + def self.new(applies_to_price_ids:, discount_type:, percentage_discount:, reason: nil); end sig do override @@ -42,8 +41,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -55,8 +53,7 @@ module Orb PERCENTAGE = T.let(:percentage, Orb::Models::PercentageDiscount::DiscountType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::PercentageDiscount::DiscountType::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/plan.rbi b/rbi/lib/orb/models/plan.rbi index 77128d83..f297bf6d 100644 --- a/rbi/lib/orb/models/plan.rbi +++ b/rbi/lib/orb/models/plan.rbi @@ -11,13 +11,13 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, - Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, - Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, - Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, - Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment - ) + T.any( + Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment + ) ] ) end @@ -119,36 +119,36 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::Price::UnitPrice, - Orb::Models::Price::PackagePrice, - Orb::Models::Price::MatrixPrice, - Orb::Models::Price::TieredPrice, - Orb::Models::Price::TieredBpsPrice, - Orb::Models::Price::BpsPrice, - Orb::Models::Price::BulkBpsPrice, - Orb::Models::Price::BulkPrice, - Orb::Models::Price::ThresholdTotalAmountPrice, - Orb::Models::Price::TieredPackagePrice, - Orb::Models::Price::GroupedTieredPrice, - Orb::Models::Price::TieredWithMinimumPrice, - Orb::Models::Price::TieredPackageWithMinimumPrice, - Orb::Models::Price::PackageWithAllocationPrice, - Orb::Models::Price::UnitWithPercentPrice, - Orb::Models::Price::MatrixWithAllocationPrice, - Orb::Models::Price::TieredWithProrationPrice, - Orb::Models::Price::UnitWithProrationPrice, - Orb::Models::Price::GroupedAllocationPrice, - Orb::Models::Price::GroupedWithProratedMinimumPrice, - Orb::Models::Price::GroupedWithMeteredMinimumPrice, - Orb::Models::Price::MatrixWithDisplayNamePrice, - Orb::Models::Price::BulkWithProrationPrice, - Orb::Models::Price::GroupedTieredPackagePrice, - Orb::Models::Price::MaxGroupTieredPackagePrice, - Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, - Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, - Orb::Models::Price::CumulativeGroupedBulkPrice - ) + T.any( + Orb::Models::Price::UnitPrice, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ) ] ) end @@ -180,14 +180,14 @@ module Orb params( id: String, adjustments: T::Array[ - T.any( - Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, - Orb::Internal::AnyHash, - Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, - Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, - Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, - Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment - ) + T.any( + Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Internal::AnyHash, + Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment + ) ], base_plan: T.nilable(T.any(Orb::Models::Plan::BasePlan, Orb::Internal::AnyHash)), base_plan_id: T.nilable(String), @@ -215,37 +215,37 @@ module Orb net_terms: T.nilable(Integer), plan_phases: T.nilable(T::Array[T.any(Orb::Models::Plan::PlanPhase, Orb::Internal::AnyHash)]), prices: T::Array[ - T.any( - Orb::Models::Price::UnitPrice, - Orb::Internal::AnyHash, - Orb::Models::Price::PackagePrice, - Orb::Models::Price::MatrixPrice, - Orb::Models::Price::TieredPrice, - Orb::Models::Price::TieredBpsPrice, - Orb::Models::Price::BpsPrice, - Orb::Models::Price::BulkBpsPrice, - Orb::Models::Price::BulkPrice, - Orb::Models::Price::ThresholdTotalAmountPrice, - Orb::Models::Price::TieredPackagePrice, - Orb::Models::Price::GroupedTieredPrice, - Orb::Models::Price::TieredWithMinimumPrice, - Orb::Models::Price::TieredPackageWithMinimumPrice, - Orb::Models::Price::PackageWithAllocationPrice, - Orb::Models::Price::UnitWithPercentPrice, - Orb::Models::Price::MatrixWithAllocationPrice, - Orb::Models::Price::TieredWithProrationPrice, - Orb::Models::Price::UnitWithProrationPrice, - Orb::Models::Price::GroupedAllocationPrice, - Orb::Models::Price::GroupedWithProratedMinimumPrice, - Orb::Models::Price::GroupedWithMeteredMinimumPrice, - Orb::Models::Price::MatrixWithDisplayNamePrice, - Orb::Models::Price::BulkWithProrationPrice, - Orb::Models::Price::GroupedTieredPackagePrice, - Orb::Models::Price::MaxGroupTieredPackagePrice, - Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, - Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, - Orb::Models::Price::CumulativeGroupedBulkPrice - ) + T.any( + Orb::Models::Price::UnitPrice, + Orb::Internal::AnyHash, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ) ], product: T.any(Orb::Models::Plan::Product, Orb::Internal::AnyHash), status: Orb::Models::Plan::Status::OrSymbol, @@ -279,22 +279,20 @@ module Orb status:, trial_config:, version: - ) - end - + ); end sig do override .returns( { id: String, adjustments: T::Array[ - T.any( - Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, - Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, - Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, - Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, - Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment - ) + T.any( + Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment + ) ], base_plan: T.nilable(Orb::Models::Plan::BasePlan), base_plan_id: T.nilable(String), @@ -321,36 +319,36 @@ module Orb net_terms: T.nilable(Integer), plan_phases: T.nilable(T::Array[Orb::Models::Plan::PlanPhase]), prices: T::Array[ - T.any( - Orb::Models::Price::UnitPrice, - Orb::Models::Price::PackagePrice, - Orb::Models::Price::MatrixPrice, - Orb::Models::Price::TieredPrice, - Orb::Models::Price::TieredBpsPrice, - Orb::Models::Price::BpsPrice, - Orb::Models::Price::BulkBpsPrice, - Orb::Models::Price::BulkPrice, - Orb::Models::Price::ThresholdTotalAmountPrice, - Orb::Models::Price::TieredPackagePrice, - Orb::Models::Price::GroupedTieredPrice, - Orb::Models::Price::TieredWithMinimumPrice, - Orb::Models::Price::TieredPackageWithMinimumPrice, - Orb::Models::Price::PackageWithAllocationPrice, - Orb::Models::Price::UnitWithPercentPrice, - Orb::Models::Price::MatrixWithAllocationPrice, - Orb::Models::Price::TieredWithProrationPrice, - Orb::Models::Price::UnitWithProrationPrice, - Orb::Models::Price::GroupedAllocationPrice, - Orb::Models::Price::GroupedWithProratedMinimumPrice, - Orb::Models::Price::GroupedWithMeteredMinimumPrice, - Orb::Models::Price::MatrixWithDisplayNamePrice, - Orb::Models::Price::BulkWithProrationPrice, - Orb::Models::Price::GroupedTieredPackagePrice, - Orb::Models::Price::MaxGroupTieredPackagePrice, - Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, - Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, - Orb::Models::Price::CumulativeGroupedBulkPrice - ) + T.any( + Orb::Models::Price::UnitPrice, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ) ], product: Orb::Models::Plan::Product, status: Orb::Models::Plan::Status::TaggedSymbol, @@ -359,8 +357,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -414,9 +411,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -431,8 +426,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -484,9 +478,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -501,8 +493,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -554,9 +545,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -571,8 +560,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -630,9 +618,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -648,8 +634,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -701,9 +686,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -718,8 +701,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -728,8 +710,7 @@ module Orb [Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end class BasePlan < Orb::Internal::Type::BaseModel @@ -749,8 +730,7 @@ module Orb params(id: T.nilable(String), external_plan_id: T.nilable(String), name: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, external_plan_id:, name:) - end + def self.new(id:, external_plan_id:, name:); end sig do override.returns( @@ -761,8 +741,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -778,12 +757,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -799,12 +776,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end class PlanPhase < Orb::Internal::Type::BaseModel @@ -897,9 +872,7 @@ module Orb minimum_amount:, name:, order: - ) - end - + ); end sig do override .returns( @@ -925,8 +898,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -942,8 +914,7 @@ module Orb ANNUAL = T.let(:annual, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol]) } - def self.values - end + def self.values; end end class Maximum < Orb::Internal::Type::BaseModel @@ -959,12 +930,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -980,12 +949,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -1000,12 +967,10 @@ module Orb attr_accessor :name sig { params(id: String, created_at: Time, name: String).returns(T.attached_class) } - def self.new(id:, created_at:, name:) - end + def self.new(id:, created_at:, name:); end sig { override.returns({id: String, created_at: Time, name: String}) } - def to_hash - end + def to_hash; end end module Status @@ -1019,8 +984,7 @@ module Orb DRAFT = T.let(:draft, Orb::Models::Plan::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Plan::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialConfig < Orb::Internal::Type::BaseModel @@ -1037,8 +1001,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(trial_period:, trial_period_unit:) - end + def self.new(trial_period:, trial_period_unit:); end sig do override @@ -1049,8 +1012,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module TrialPeriodUnit extend Orb::Internal::Type::Enum @@ -1062,8 +1024,7 @@ module Orb DAYS = T.let(:days, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/plan_create_params.rbi b/rbi/lib/orb/models/plan_create_params.rbi index 2a8bd107..8be66bf5 100644 --- a/rbi/lib/orb/models/plan_create_params.rbi +++ b/rbi/lib/orb/models/plan_create_params.rbi @@ -19,33 +19,33 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, - Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, - Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, - Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, - Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice - ) + T.any( + Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, + Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, + Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, + Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, + Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice + ) ] ) end @@ -83,34 +83,34 @@ module Orb currency: String, name: String, prices: T::Array[ - T.any( - Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, - Orb::Internal::AnyHash, - Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, - Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, - Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, - Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice - ) + T.any( + Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, + Orb::Internal::AnyHash, + Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, + Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, + Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, + Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice + ) ], default_invoice_memo: T.nilable(String), external_plan_id: T.nilable(String), @@ -131,9 +131,7 @@ module Orb net_terms: nil, status: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -141,33 +139,33 @@ module Orb currency: String, name: String, prices: T::Array[ - T.any( - Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, - Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, - Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, - Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, - Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice - ) + T.any( + Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, + Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, + Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, + Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, + Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice + ) ], default_invoice_memo: T.nilable(String), external_plan_id: T.nilable(String), @@ -178,8 +176,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Price extend Orb::Internal::Type::Union @@ -331,9 +328,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit - ) - end - + ); end sig do override .returns( @@ -356,8 +351,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -379,8 +373,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class UnitConfig < Orb::Internal::Type::BaseModel @@ -389,12 +382,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:) - end + def self.new(unit_amount:); end sig { override.returns({unit_amount: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -419,8 +410,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -431,8 +421,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -466,12 +455,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -497,8 +485,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -509,8 +496,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -544,12 +530,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -701,9 +686,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :package - ) - end - + ); end sig do override .returns( @@ -726,8 +709,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -753,8 +735,7 @@ module Orb override .returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence::TaggedSymbol]) end - def self.values - end + def self.values; end end class PackageConfig < Orb::Internal::Type::BaseModel @@ -768,12 +749,10 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:) - end + def self.new(package_amount:, package_size:); end sig { override.returns({package_amount: String, package_size: Integer}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -798,8 +777,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -810,8 +788,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -845,12 +822,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -876,8 +852,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -888,8 +863,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -923,12 +897,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -1080,9 +1053,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix - ) - end - + ); end sig do override .returns( @@ -1105,8 +1076,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -1131,8 +1101,7 @@ module Orb sig do override.returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence::TaggedSymbol]) end - def self.values - end + def self.values; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -1153,16 +1122,15 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - T.any( - Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig::MatrixValue, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::MatrixConfig::MatrixValue, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -1174,8 +1142,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -1194,12 +1161,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -1225,8 +1190,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1237,8 +1201,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1272,12 +1235,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1303,8 +1265,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1315,8 +1276,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1350,12 +1310,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -1507,9 +1466,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered - ) - end - + ); end sig do override .returns( @@ -1532,8 +1489,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -1558,8 +1514,7 @@ module Orb sig do override.returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence::TaggedSymbol]) end - def self.values - end + def self.values; end end class TieredConfig < Orb::Internal::Type::BaseModel @@ -1570,23 +1525,21 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns({tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig::Tier]}) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Inclusive tier starting value @@ -1608,12 +1561,10 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil) - end + def self.new(first_unit:, unit_amount:, last_unit: nil); end sig { override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -1639,8 +1590,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1651,8 +1601,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1686,12 +1635,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1717,8 +1665,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1729,8 +1676,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1764,12 +1710,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -1931,9 +1876,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps - ) - end - + ); end sig do override .returns( @@ -1956,8 +1899,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -1985,8 +1927,7 @@ module Orb override .returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence::TaggedSymbol]) end - def self.values - end + def self.values; end end class TieredBpsConfig < Orb::Internal::Type::BaseModel @@ -1998,16 +1939,15 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override @@ -2015,8 +1955,7 @@ module Orb {tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig::Tier]} ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Per-event basis point rate @@ -2044,8 +1983,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end sig do override @@ -2058,8 +1996,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -2085,8 +2022,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2097,8 +2033,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2132,12 +2067,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -2163,8 +2097,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2175,8 +2108,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2210,12 +2142,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -2367,9 +2298,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps - ) - end - + ); end sig do override .returns( @@ -2392,8 +2321,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BpsConfig < Orb::Internal::Type::BaseModel # Basis point take rate per event @@ -2405,12 +2333,10 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil) - end + def self.new(bps:, per_unit_maximum: nil); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } - def to_hash - end + def to_hash; end end # The cadence to bill for this price on. @@ -2432,8 +2358,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -2458,8 +2383,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2470,8 +2394,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2505,12 +2428,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -2536,8 +2458,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2548,8 +2469,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2583,12 +2503,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -2740,9 +2659,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps - ) - end - + ); end sig do override .returns( @@ -2765,8 +2682,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -2777,23 +2693,21 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns({tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier]}) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Basis points to rate on @@ -2812,8 +2726,7 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end sig do override.returns( @@ -2824,8 +2737,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -2853,8 +2765,7 @@ module Orb override .returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence::TaggedSymbol]) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -2879,8 +2790,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2891,8 +2801,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2926,12 +2835,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -2957,8 +2865,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2969,8 +2876,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3004,12 +2910,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3161,9 +3066,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk - ) - end - + ); end sig do override .returns( @@ -3186,8 +3089,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkConfig < Orb::Internal::Type::BaseModel # Bulk tiers for rating based on total usage volume @@ -3200,15 +3102,13 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns({tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig::Tier]}) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Amount per unit @@ -3220,12 +3120,10 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil) - end + def self.new(unit_amount:, maximum_units: nil); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -3249,8 +3147,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -3275,8 +3172,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3287,8 +3183,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3322,12 +3217,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -3353,8 +3247,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3365,8 +3258,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3400,12 +3292,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3561,9 +3452,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount - ) - end - + ); end sig do override .returns( @@ -3590,8 +3479,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -3645,8 +3533,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -3671,8 +3558,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3683,8 +3569,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3718,12 +3603,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -3749,8 +3633,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3761,8 +3644,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3796,12 +3678,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3953,9 +3834,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package - ) - end - + ); end sig do override .returns( @@ -3978,8 +3857,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -4016,8 +3894,7 @@ module Orb override .returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence::TaggedSymbol]) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4042,8 +3919,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4054,8 +3930,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4089,12 +3964,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -4120,8 +3994,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4132,8 +4005,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4167,12 +4039,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -4326,9 +4197,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum - ) - end - + ); end sig do override .returns( @@ -4353,8 +4222,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -4402,8 +4270,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4428,8 +4295,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4440,8 +4306,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4475,12 +4340,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -4506,8 +4370,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4518,8 +4381,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4553,12 +4415,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -4710,9 +4571,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent - ) - end - + ); end sig do override .returns( @@ -4735,8 +4594,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -4778,8 +4636,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4804,8 +4661,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4816,8 +4672,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4851,12 +4706,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -4882,8 +4736,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4894,8 +4747,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4929,12 +4781,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5090,9 +4941,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation - ) - end - + ); end sig do override .returns( @@ -5119,8 +4968,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5174,8 +5022,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5200,8 +5047,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5212,8 +5058,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5247,12 +5092,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5278,8 +5122,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5290,8 +5133,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5325,12 +5167,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5484,9 +5325,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration - ) - end - + ); end sig do override .returns( @@ -5511,8 +5350,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5560,8 +5398,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5586,8 +5423,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5598,8 +5434,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5633,12 +5468,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5664,8 +5498,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5676,8 +5509,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5711,12 +5543,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5870,9 +5701,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration - ) - end - + ); end sig do override .returns( @@ -5897,8 +5726,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5946,8 +5774,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5972,8 +5799,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5984,8 +5810,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6019,12 +5844,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6050,8 +5874,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6062,8 +5885,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6097,12 +5919,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -6256,9 +6077,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation - ) - end - + ); end sig do override .returns( @@ -6283,8 +6102,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -6332,8 +6150,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6358,8 +6175,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6370,8 +6186,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6405,12 +6220,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6436,8 +6250,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6448,8 +6261,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6483,12 +6295,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -6644,9 +6455,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_prorated_minimum - ) - end - + ); end sig do override .returns( @@ -6673,8 +6482,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -6728,8 +6536,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6754,8 +6561,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6766,8 +6572,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6801,12 +6606,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6832,8 +6636,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6844,8 +6647,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6879,12 +6681,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7040,9 +6841,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_metered_minimum - ) - end - + ); end sig do override .returns( @@ -7069,8 +6868,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7124,8 +6922,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7150,8 +6947,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7162,8 +6958,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7197,12 +6992,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -7228,8 +7022,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7240,8 +7033,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7275,12 +7067,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7436,9 +7227,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_display_name - ) - end - + ); end sig do override .returns( @@ -7465,8 +7254,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7520,8 +7308,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7546,8 +7333,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7558,8 +7344,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7593,12 +7378,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -7624,8 +7408,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7636,8 +7419,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7671,12 +7453,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7830,9 +7611,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration - ) - end - + ); end sig do override .returns( @@ -7857,8 +7636,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7906,8 +7684,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7932,8 +7709,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7944,8 +7720,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7979,12 +7754,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8010,8 +7784,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8022,8 +7795,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8057,12 +7829,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -8218,9 +7989,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package - ) - end - + ); end sig do override .returns( @@ -8247,8 +8016,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -8302,8 +8070,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8328,8 +8095,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8340,8 +8106,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8375,12 +8140,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8406,8 +8170,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8418,8 +8181,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8453,12 +8215,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -8614,9 +8375,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :max_group_tiered_package - ) - end - + ); end sig do override .returns( @@ -8643,8 +8402,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -8698,8 +8456,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8724,8 +8481,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8736,8 +8492,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8771,12 +8526,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8802,8 +8556,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8814,8 +8567,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8849,12 +8601,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9014,9 +8765,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_unit_pricing - ) - end - + ); end sig do override .returns( @@ -9043,8 +8792,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9098,8 +8846,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9124,8 +8871,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9136,8 +8882,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9171,12 +8916,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9202,8 +8946,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9214,8 +8957,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9249,12 +8991,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9414,9 +9155,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_tiered_pricing - ) - end - + ); end sig do override .returns( @@ -9443,8 +9182,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9498,8 +9236,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9524,8 +9261,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9536,8 +9272,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9571,12 +9306,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9602,8 +9336,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9614,8 +9347,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9649,12 +9381,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9810,9 +9541,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk - ) - end - + ); end sig do override .returns( @@ -9839,8 +9568,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9894,8 +9622,7 @@ module Orb T::Array[Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9920,8 +9647,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9932,8 +9658,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9967,12 +9692,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9998,8 +9722,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10010,8 +9733,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10045,12 +9767,11 @@ module Orb override .returns( T::Array[ - Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -10061,8 +9782,7 @@ module Orb [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice] ) end - def self.variants - end + def self.variants; end end # The status of the plan to create (either active or draft). If not specified, @@ -10077,8 +9797,7 @@ module Orb DRAFT = T.let(:draft, Orb::Models::PlanCreateParams::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::PlanCreateParams::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/plan_fetch_params.rbi b/rbi/lib/orb/models/plan_fetch_params.rbi index cc89ebe4..8cc2d0ab 100644 --- a/rbi/lib/orb/models/plan_fetch_params.rbi +++ b/rbi/lib/orb/models/plan_fetch_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/plan_list_params.rbi b/rbi/lib/orb/models/plan_list_params.rbi index 81c17ed9..30e387c3 100644 --- a/rbi/lib/orb/models/plan_list_params.rbi +++ b/rbi/lib/orb/models/plan_list_params.rbi @@ -59,9 +59,7 @@ module Orb limit: nil, status: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -77,8 +75,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The plan status to filter to ('active', 'archived', or 'draft'). module Status @@ -92,8 +89,7 @@ module Orb DRAFT = T.let(:draft, Orb::Models::PlanListParams::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::PlanListParams::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/plan_update_params.rbi b/rbi/lib/orb/models/plan_update_params.rbi index b88f14d1..e9612477 100644 --- a/rbi/lib/orb/models/plan_update_params.rbi +++ b/rbi/lib/orb/models/plan_update_params.rbi @@ -26,8 +26,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(external_plan_id: nil, metadata: nil, request_options: {}) - end + def self.new(external_plan_id: nil, metadata: nil, request_options: {}); end sig do override @@ -39,8 +38,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi b/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi index f8fb36e8..02a432c8 100644 --- a/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +++ b/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi @@ -15,12 +15,10 @@ module Orb ) ).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi b/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi index d1844612..306f978d 100644 --- a/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +++ b/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi @@ -27,8 +27,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(external_plan_id: nil, metadata: nil, request_options: {}) - end + def self.new(external_plan_id: nil, metadata: nil, request_options: {}); end sig do override @@ -40,8 +39,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/price.rbi b/rbi/lib/orb/models/price.rbi index a6acaf7b..86b3f905 100644 --- a/rbi/lib/orb/models/price.rbi +++ b/rbi/lib/orb/models/price.rbi @@ -217,9 +217,7 @@ module Orb unit_config:, dimensional_price_configuration: nil, model_type: :unit - ) - end - + ); end sig do override .returns( @@ -258,20 +256,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -288,8 +283,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -300,8 +294,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -325,8 +318,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -344,8 +336,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::UnitPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::UnitPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -356,12 +347,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -378,8 +367,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -390,8 +378,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -415,8 +402,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -428,12 +414,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -449,12 +433,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -470,12 +452,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -488,8 +468,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::UnitPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::UnitPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class UnitConfig < Orb::Internal::Type::BaseModel @@ -498,12 +477,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:) - end + def self.new(unit_amount:); end sig { override.returns({unit_amount: String}) } - def to_hash - end + def to_hash; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -519,12 +496,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -648,7 +623,9 @@ module Orb sig { returns(Orb::Models::Price::PackagePrice::PackageConfig) } attr_reader :package_config - sig { params(package_config: T.any(Orb::Models::Price::PackagePrice::PackageConfig, Orb::Internal::AnyHash)).void } + sig do + params(package_config: T.any(Orb::Models::Price::PackagePrice::PackageConfig, Orb::Internal::AnyHash)).void + end attr_writer :package_config sig { returns(T.nilable(Integer)) } @@ -730,9 +707,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :package - ) - end - + ); end sig do override .returns( @@ -771,20 +746,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -801,8 +773,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -813,8 +784,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -839,8 +809,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -859,8 +828,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::PackagePrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::PackagePrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -871,12 +839,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -893,8 +859,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -905,8 +870,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -933,8 +897,7 @@ module Orb T::Array[Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -946,12 +909,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -967,12 +928,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -988,12 +947,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end class PackageConfig < Orb::Internal::Type::BaseModel @@ -1007,12 +964,10 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:) - end + def self.new(package_amount:, package_size:); end sig { override.returns({package_amount: String, package_size: Integer}) } - def to_hash - end + def to_hash; end end module PriceType @@ -1026,8 +981,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::PackagePrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::PackagePrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -1043,12 +997,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -1254,9 +1206,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :matrix - ) - end - + ); end sig do override .returns( @@ -1295,20 +1245,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -1325,8 +1272,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1337,8 +1283,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -1362,8 +1307,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -1381,8 +1325,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::MatrixPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::MatrixPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -1393,12 +1336,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -1415,8 +1356,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1427,8 +1367,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -1455,8 +1394,7 @@ module Orb T::Array[Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -1468,12 +1406,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -1497,8 +1433,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -1510,8 +1445,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -1530,12 +1464,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -1552,12 +1484,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -1573,12 +1503,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -1592,8 +1520,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::MatrixPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::MatrixPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -1609,12 +1536,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -1820,9 +1745,7 @@ module Orb tiered_config:, dimensional_price_configuration: nil, model_type: :tiered - ) - end - + ); end sig do override .returns( @@ -1861,20 +1784,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -1891,8 +1811,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1903,8 +1822,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -1928,8 +1846,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -1947,8 +1864,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::TieredPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -1959,12 +1875,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -1981,8 +1895,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1993,8 +1906,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -2021,8 +1933,7 @@ module Orb T::Array[Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -2034,12 +1945,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -2055,12 +1964,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -2076,12 +1983,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -2095,8 +2000,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class TieredConfig < Orb::Internal::Type::BaseModel @@ -2110,12 +2014,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig { override.returns({tiers: T::Array[Orb::Models::Price::TieredPrice::TieredConfig::Tier]}) } - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Inclusive tier starting value @@ -2137,12 +2039,10 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil) - end + def self.new(first_unit:, unit_amount:, last_unit: nil); end sig { override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -2159,12 +2059,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -2257,7 +2155,9 @@ module Orb sig { returns(T.nilable(Orb::Models::Price::TieredBpsPrice::Maximum)) } attr_reader :maximum - sig { params(maximum: T.nilable(T.any(Orb::Models::Price::TieredBpsPrice::Maximum, Orb::Internal::AnyHash))).void } + sig do + params(maximum: T.nilable(T.any(Orb::Models::Price::TieredBpsPrice::Maximum, Orb::Internal::AnyHash))).void + end attr_writer :maximum sig { returns(T.nilable(String)) } @@ -2273,7 +2173,9 @@ module Orb sig { returns(T.nilable(Orb::Models::Price::TieredBpsPrice::Minimum)) } attr_reader :minimum - sig { params(minimum: T.nilable(T.any(Orb::Models::Price::TieredBpsPrice::Minimum, Orb::Internal::AnyHash))).void } + sig do + params(minimum: T.nilable(T.any(Orb::Models::Price::TieredBpsPrice::Minimum, Orb::Internal::AnyHash))).void + end attr_writer :minimum sig { returns(T.nilable(String)) } @@ -2379,9 +2281,7 @@ module Orb tiered_bps_config:, dimensional_price_configuration: nil, model_type: :tiered_bps - ) - end - + ); end sig do override .returns( @@ -2420,20 +2320,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -2450,8 +2347,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2462,8 +2358,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -2490,8 +2385,7 @@ module Orb T::Array[Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -2510,8 +2404,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::TieredBpsPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredBpsPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -2522,12 +2415,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -2544,8 +2435,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2556,8 +2446,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -2584,8 +2473,7 @@ module Orb T::Array[Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -2597,12 +2485,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -2618,12 +2504,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -2639,12 +2523,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -2658,8 +2540,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredBpsPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredBpsPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class TieredBpsConfig < Orb::Internal::Type::BaseModel @@ -2674,12 +2555,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig { override.returns({tiers: T::Array[Orb::Models::Price::TieredBpsPrice::TieredBpsConfig::Tier]}) } - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Per-event basis point rate @@ -2707,8 +2586,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end sig do override @@ -2721,8 +2599,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -2739,12 +2616,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -2950,9 +2825,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :bps - ) - end - + ); end sig do override .returns( @@ -2991,20 +2864,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -3021,8 +2891,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3033,8 +2902,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -3052,8 +2920,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -3067,12 +2934,10 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil) - end + def self.new(bps:, per_unit_maximum: nil); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } - def to_hash - end + def to_hash; end end module Cadence @@ -3089,8 +2954,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::BpsPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::BpsPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -3101,12 +2965,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -3123,8 +2985,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3135,8 +2996,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -3160,8 +3020,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -3173,12 +3032,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -3194,12 +3051,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -3215,12 +3070,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -3233,8 +3086,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BpsPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::BpsPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -3250,12 +3102,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -3464,9 +3314,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :bulk_bps - ) - end - + ); end sig do override .returns( @@ -3505,20 +3353,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -3535,8 +3380,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3547,8 +3391,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -3573,8 +3416,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -3590,12 +3432,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig { override.returns({tiers: T::Array[Orb::Models::Price::BulkBpsPrice::BulkBpsConfig::Tier]}) } - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Basis points to rate on @@ -3614,8 +3454,7 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end sig do override.returns( @@ -3626,8 +3465,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -3646,8 +3484,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::BulkBpsPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::BulkBpsPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -3658,12 +3495,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -3680,8 +3515,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3692,8 +3526,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -3720,8 +3553,7 @@ module Orb T::Array[Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -3733,12 +3565,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -3754,12 +3584,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -3775,12 +3603,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -3794,8 +3620,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BulkBpsPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::BulkBpsPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -3811,12 +3636,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -4022,9 +3845,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :bulk - ) - end - + ); end sig do override .returns( @@ -4063,20 +3884,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4093,8 +3911,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4105,8 +3922,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -4130,8 +3946,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -4144,12 +3959,10 @@ module Orb params(tiers: T::Array[T.any(Orb::Models::Price::BulkPrice::BulkConfig::Tier, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig { override.returns({tiers: T::Array[Orb::Models::Price::BulkPrice::BulkConfig::Tier]}) } - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Amount per unit @@ -4161,12 +3974,10 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil) - end + def self.new(unit_amount:, maximum_units: nil); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -4184,8 +3995,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::BulkPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::BulkPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -4196,12 +4006,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4218,8 +4026,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4230,8 +4037,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -4255,8 +4061,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -4268,12 +4073,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -4289,12 +4092,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -4310,12 +4111,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -4328,8 +4127,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BulkPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::BulkPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -4345,12 +4143,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -4577,9 +4373,7 @@ module Orb threshold_total_amount_config:, dimensional_price_configuration: nil, model_type: :threshold_total_amount - ) - end - + ); end sig do override .returns( @@ -4618,20 +4412,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4652,8 +4443,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4664,8 +4454,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -4698,8 +4487,7 @@ module Orb T::Array[Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -4718,8 +4506,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::ThresholdTotalAmountPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -4730,12 +4517,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4756,8 +4541,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4768,8 +4552,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -4802,8 +4585,7 @@ module Orb T::Array[Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -4815,12 +4597,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -4836,12 +4616,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -4857,12 +4635,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -4876,8 +4652,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::ThresholdTotalAmountPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -4893,12 +4668,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -5115,9 +4888,7 @@ module Orb tiered_package_config:, dimensional_price_configuration: nil, model_type: :tiered_package - ) - end - + ); end sig do override .returns( @@ -5156,20 +4927,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5186,8 +4954,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5198,8 +4965,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -5229,8 +4995,7 @@ module Orb T::Array[Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -5249,8 +5014,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::TieredPackagePrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredPackagePrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -5261,12 +5025,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5283,8 +5045,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5295,8 +5056,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -5329,8 +5089,7 @@ module Orb T::Array[Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -5342,12 +5101,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -5363,12 +5120,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -5384,12 +5139,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -5403,8 +5156,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredPackagePrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredPackagePrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -5420,12 +5172,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -5642,9 +5392,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :grouped_tiered - ) - end - + ); end sig do override .returns( @@ -5683,20 +5431,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5713,8 +5458,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5725,8 +5469,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -5756,8 +5499,7 @@ module Orb T::Array[Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -5776,8 +5518,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::GroupedTieredPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedTieredPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -5788,12 +5529,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5810,8 +5549,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5822,8 +5560,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -5856,8 +5593,7 @@ module Orb T::Array[Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -5869,12 +5605,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -5890,12 +5624,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -5911,12 +5643,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -5930,8 +5660,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::GroupedTieredPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedTieredPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -5947,12 +5676,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -6173,9 +5900,7 @@ module Orb tiered_with_minimum_config:, dimensional_price_configuration: nil, model_type: :tiered_with_minimum - ) - end - + ); end sig do override .returns( @@ -6214,20 +5939,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6244,8 +5966,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6256,8 +5977,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -6290,8 +6010,7 @@ module Orb T::Array[Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -6310,8 +6029,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::TieredWithMinimumPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredWithMinimumPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -6322,12 +6040,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6348,8 +6064,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6360,8 +6075,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -6394,8 +6108,7 @@ module Orb T::Array[Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -6407,12 +6120,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -6428,12 +6139,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -6449,12 +6158,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -6468,8 +6175,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredWithMinimumPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredWithMinimumPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -6485,12 +6191,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -6737,9 +6441,7 @@ module Orb tiered_package_with_minimum_config:, dimensional_price_configuration: nil, model_type: :tiered_package_with_minimum - ) - end - + ); end sig do override .returns( @@ -6778,20 +6480,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6812,8 +6511,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6824,8 +6522,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -6858,8 +6555,7 @@ module Orb T::Array[Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -6879,8 +6575,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -6891,12 +6586,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6917,8 +6610,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6929,8 +6621,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -6965,8 +6656,7 @@ module Orb T::Array[Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -6978,12 +6668,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -6999,12 +6687,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -7020,12 +6706,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -7042,8 +6726,7 @@ module Orb T.let(:fixed_price, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -7059,12 +6742,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -7291,9 +6972,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :package_with_allocation - ) - end - + ); end sig do override .returns( @@ -7332,20 +7011,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7366,8 +7042,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7378,8 +7053,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -7412,8 +7086,7 @@ module Orb T::Array[Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -7432,8 +7105,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::PackageWithAllocationPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::PackageWithAllocationPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -7444,12 +7116,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7470,8 +7140,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7482,8 +7151,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -7516,8 +7184,7 @@ module Orb T::Array[Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -7529,12 +7196,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -7550,12 +7215,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -7571,12 +7234,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -7592,8 +7253,7 @@ module Orb T.let(:fixed_price, Orb::Models::Price::PackageWithAllocationPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::PackageWithAllocationPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -7609,12 +7269,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -7835,9 +7493,7 @@ module Orb unit_with_percent_config:, dimensional_price_configuration: nil, model_type: :unit_with_percent - ) - end - + ); end sig do override .returns( @@ -7876,20 +7532,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7906,8 +7559,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7918,8 +7570,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -7952,8 +7603,7 @@ module Orb T::Array[Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -7972,8 +7622,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::UnitWithPercentPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::UnitWithPercentPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -7984,12 +7633,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8006,8 +7653,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8018,8 +7664,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -8052,8 +7697,7 @@ module Orb T::Array[Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -8065,12 +7709,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -8086,12 +7728,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -8107,12 +7747,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -8126,8 +7764,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::UnitWithPercentPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::UnitWithPercentPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -8143,12 +7780,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -8383,9 +8018,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :matrix_with_allocation - ) - end - + ); end sig do override .returns( @@ -8424,20 +8057,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8458,8 +8088,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8470,8 +8099,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -8504,8 +8132,7 @@ module Orb T::Array[Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -8524,8 +8151,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::MatrixWithAllocationPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::MatrixWithAllocationPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -8536,12 +8162,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8562,8 +8186,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8574,8 +8197,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -8608,8 +8230,7 @@ module Orb T::Array[Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -8621,12 +8242,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel @@ -8652,16 +8271,15 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - T.any( - Orb::Models::Price::MatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::Price::MatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -8674,8 +8292,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -8694,12 +8311,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -8716,12 +8331,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -8737,12 +8350,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -8756,8 +8367,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::MatrixWithAllocationPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::MatrixWithAllocationPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -8773,12 +8383,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -8999,9 +8607,7 @@ module Orb tiered_with_proration_config:, dimensional_price_configuration: nil, model_type: :tiered_with_proration - ) - end - + ); end sig do override .returns( @@ -9040,20 +8646,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9074,8 +8677,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9086,8 +8688,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -9120,8 +8721,7 @@ module Orb T::Array[Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -9140,8 +8740,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::TieredWithProrationPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredWithProrationPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -9152,12 +8751,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9178,8 +8775,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9190,8 +8786,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -9224,8 +8819,7 @@ module Orb T::Array[Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -9237,12 +8831,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -9258,12 +8850,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -9279,12 +8869,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -9298,8 +8886,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredWithProrationPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::TieredWithProrationPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -9315,12 +8902,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -9541,9 +9126,7 @@ module Orb unit_with_proration_config:, dimensional_price_configuration: nil, model_type: :unit_with_proration - ) - end - + ); end sig do override .returns( @@ -9582,20 +9165,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9612,8 +9192,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9624,8 +9203,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -9658,8 +9236,7 @@ module Orb T::Array[Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -9678,8 +9255,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::UnitWithProrationPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::UnitWithProrationPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -9690,12 +9266,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9716,8 +9290,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9728,8 +9301,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -9762,8 +9334,7 @@ module Orb T::Array[Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -9775,12 +9346,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -9796,12 +9365,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -9817,12 +9384,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -9836,8 +9401,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::UnitWithProrationPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::UnitWithProrationPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -9853,12 +9417,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -10079,9 +9641,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :grouped_allocation - ) - end - + ); end sig do override .returns( @@ -10120,20 +9680,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10150,8 +9707,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10162,8 +9718,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -10196,8 +9751,7 @@ module Orb T::Array[Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -10216,8 +9770,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::GroupedAllocationPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedAllocationPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -10228,12 +9781,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10254,8 +9805,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10266,8 +9816,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -10300,8 +9849,7 @@ module Orb T::Array[Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -10313,12 +9861,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -10334,12 +9880,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -10355,12 +9899,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -10374,8 +9916,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::GroupedAllocationPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedAllocationPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -10391,12 +9932,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -10498,7 +10037,9 @@ module Orb sig { returns(Orb::Models::Price::GroupedWithProratedMinimumPrice::Item) } attr_reader :item - sig { params(item: T.any(Orb::Models::Price::GroupedWithProratedMinimumPrice::Item, Orb::Internal::AnyHash)).void } + sig do + params(item: T.any(Orb::Models::Price::GroupedWithProratedMinimumPrice::Item, Orb::Internal::AnyHash)).void + end attr_writer :item sig { returns(T.nilable(Orb::Models::Price::GroupedWithProratedMinimumPrice::Maximum)) } @@ -10643,9 +10184,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :grouped_with_prorated_minimum - ) - end - + ); end sig do override .returns( @@ -10684,20 +10223,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10718,8 +10254,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10730,8 +10265,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -10766,8 +10300,7 @@ module Orb T::Array[Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -10788,8 +10321,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -10800,12 +10332,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10826,8 +10356,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10838,8 +10367,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -10872,12 +10400,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -10889,12 +10416,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -10910,12 +10435,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -10931,12 +10454,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -10953,8 +10474,7 @@ module Orb T.let(:fixed_price, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -10970,12 +10490,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -11222,9 +10740,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :grouped_with_metered_minimum - ) - end - + ); end sig do override .returns( @@ -11263,20 +10779,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11297,8 +10810,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11309,8 +10821,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -11343,8 +10854,7 @@ module Orb T::Array[Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -11365,8 +10875,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -11377,12 +10886,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11403,8 +10910,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11415,8 +10921,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -11449,12 +10954,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -11466,12 +10970,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -11487,12 +10989,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -11508,12 +11008,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -11530,8 +11028,7 @@ module Orb T.let(:fixed_price, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -11547,12 +11044,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -11779,9 +11274,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :matrix_with_display_name - ) - end - + ); end sig do override .returns( @@ -11820,20 +11313,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11854,8 +11344,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11866,8 +11355,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -11900,8 +11388,7 @@ module Orb T::Array[Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -11920,8 +11407,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -11932,12 +11418,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11958,8 +11442,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11970,8 +11453,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -12004,8 +11486,7 @@ module Orb T::Array[Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -12017,12 +11498,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -12038,12 +11517,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -12059,12 +11536,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -12080,8 +11555,7 @@ module Orb T.let(:fixed_price, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -12097,12 +11571,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -12323,9 +11795,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :bulk_with_proration - ) - end - + ); end sig do override .returns( @@ -12364,20 +11834,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -12394,8 +11861,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -12406,8 +11872,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -12440,8 +11905,7 @@ module Orb T::Array[Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -12460,8 +11924,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::BulkWithProrationPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::BulkWithProrationPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -12472,12 +11935,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -12498,8 +11959,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -12510,8 +11970,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -12544,8 +12003,7 @@ module Orb T::Array[Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -12557,12 +12015,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -12578,12 +12034,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -12599,12 +12053,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -12618,8 +12070,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BulkWithProrationPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::BulkWithProrationPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -12635,12 +12086,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -12867,9 +12316,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :grouped_tiered_package - ) - end - + ); end sig do override .returns( @@ -12908,20 +12355,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -12942,8 +12386,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -12954,8 +12397,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -12988,8 +12430,7 @@ module Orb T::Array[Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -13008,8 +12449,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::GroupedTieredPackagePrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedTieredPackagePrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -13020,12 +12460,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -13046,8 +12484,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13058,8 +12495,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -13092,8 +12528,7 @@ module Orb T::Array[Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -13105,12 +12540,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -13126,12 +12559,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -13147,12 +12578,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -13166,8 +12595,7 @@ module Orb FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::GroupedTieredPackagePrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::GroupedTieredPackagePrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -13183,12 +12611,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -13415,9 +12841,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :max_group_tiered_package - ) - end - + ); end sig do override .returns( @@ -13456,20 +12880,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -13490,8 +12911,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13502,8 +12922,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -13536,8 +12955,7 @@ module Orb T::Array[Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -13556,8 +12974,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -13568,12 +12985,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -13594,8 +13009,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13606,8 +13020,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -13640,8 +13053,7 @@ module Orb T::Array[Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -13653,12 +13065,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -13674,12 +13084,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -13695,12 +13103,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -13716,8 +13122,7 @@ module Orb T.let(:fixed_price, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -13733,12 +13138,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -13988,9 +13391,7 @@ module Orb scalable_matrix_with_unit_pricing_config:, dimensional_price_configuration: nil, model_type: :scalable_matrix_with_unit_pricing - ) - end - + ); end sig do override .returns( @@ -14029,20 +13430,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -14063,8 +13461,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14075,8 +13472,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -14109,12 +13505,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -14137,8 +13532,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -14149,12 +13543,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -14175,8 +13567,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14187,8 +13578,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -14221,12 +13611,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -14238,12 +13627,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -14259,12 +13646,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -14280,12 +13665,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -14304,8 +13687,7 @@ module Orb sig do override.returns(T::Array[Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType::TaggedSymbol]) end - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -14321,12 +13703,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -14590,9 +13970,7 @@ module Orb scalable_matrix_with_tiered_pricing_config:, dimensional_price_configuration: nil, model_type: :scalable_matrix_with_tiered_pricing - ) - end - + ); end sig do override .returns( @@ -14631,20 +14009,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -14665,8 +14040,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14677,8 +14051,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -14711,12 +14084,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -14742,8 +14114,7 @@ module Orb sig do override.returns(T::Array[Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol]) end - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -14754,12 +14125,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -14780,8 +14149,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14792,8 +14160,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -14826,12 +14193,11 @@ module Orb override .returns( T::Array[ - Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -14843,12 +14209,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -14864,12 +14228,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -14885,12 +14247,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -14910,8 +14270,7 @@ module Orb override .returns(T::Array[Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType::TaggedSymbol]) end - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -14927,12 +14286,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -15159,9 +14516,7 @@ module Orb price_type:, dimensional_price_configuration: nil, model_type: :cumulative_grouped_bulk - ) - end - + ); end sig do override .returns( @@ -15200,20 +14555,17 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id sig { params(id: String).returns(T.attached_class) } - def self.new(id:) - end + def self.new(id:); end sig { override.returns({id: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -15234,8 +14586,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15246,8 +14597,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -15280,8 +14630,7 @@ module Orb T::Array[Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -15300,8 +14649,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end class CreditAllocation < Orb::Internal::Type::BaseModel @@ -15312,12 +14660,10 @@ module Orb attr_accessor :currency sig { params(allows_rollover: T::Boolean, currency: String).returns(T.attached_class) } - def self.new(allows_rollover:, currency:) - end + def self.new(allows_rollover:, currency:); end sig { override.returns({allows_rollover: T::Boolean, currency: String}) } - def to_hash - end + def to_hash; end end class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -15338,8 +14684,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15350,8 +14695,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DurationUnit extend Orb::Internal::Type::Enum @@ -15384,8 +14728,7 @@ module Orb T::Array[Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -15397,12 +14740,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Maximum < Orb::Internal::Type::BaseModel @@ -15418,12 +14759,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, maximum_amount:) - end + def self.new(applies_to_price_ids:, maximum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) } - def to_hash - end + def to_hash; end end class Minimum < Orb::Internal::Type::BaseModel @@ -15439,12 +14778,10 @@ module Orb sig do params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class) end - def self.new(applies_to_price_ids:, minimum_amount:) - end + def self.new(applies_to_price_ids:, minimum_amount:); end sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) } - def to_hash - end + def to_hash; end end module PriceType @@ -15460,8 +14797,7 @@ module Orb T.let(:fixed_price, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType::TaggedSymbol]) } - def self.values - end + def self.values; end end class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel @@ -15477,12 +14813,10 @@ module Orb dimensional_price_group_id: String ).returns(T.attached_class) end - def self.new(dimension_values:, dimensional_price_group_id:) - end + def self.new(dimension_values:, dimensional_price_group_id:); end sig { override.returns({dimension_values: T::Array[String], dimensional_price_group_id: String}) } - def to_hash - end + def to_hash; end end end @@ -15492,8 +14826,7 @@ module Orb [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/price_create_params.rbi b/rbi/lib/orb/models/price_create_params.rbi index 633c492c..2506d9d8 100644 --- a/rbi/lib/orb/models/price_create_params.rbi +++ b/rbi/lib/orb/models/price_create_params.rbi @@ -295,9 +295,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -348,8 +346,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -366,8 +363,7 @@ module Orb CUSTOM = T.let(:custom, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::PriceCreateParams::Cadence::TaggedSymbol]) } - def self.values - end + def self.values; end end module ModelType @@ -381,8 +377,7 @@ module Orb T.let(:cumulative_grouped_bulk, Orb::Models::PriceCreateParams::ModelType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::PriceCreateParams::ModelType::TaggedSymbol]) } - def self.values - end + def self.values; end end class UnitConfig < Orb::Internal::Type::BaseModel @@ -391,12 +386,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:) - end + def self.new(unit_amount:); end sig { override.returns({unit_amount: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -417,8 +410,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -429,8 +421,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -455,8 +446,7 @@ module Orb override .returns(T::Array[Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -478,8 +468,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -490,8 +479,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -517,8 +505,7 @@ module Orb override .returns(T::Array[Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -533,12 +520,10 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:) - end + def self.new(package_amount:, package_size:); end sig { override.returns({package_amount: String, package_size: Integer}) } - def to_hash - end + def to_hash; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -562,8 +547,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -575,8 +559,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -595,12 +578,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -630,8 +611,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -644,8 +624,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -664,12 +643,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -682,12 +659,10 @@ module Orb params(tiers: T::Array[T.any(Orb::Models::PriceCreateParams::TieredConfig::Tier, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::TieredConfig::Tier]}) } - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Inclusive tier starting value @@ -709,12 +684,10 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil) - end + def self.new(first_unit:, unit_amount:, last_unit: nil); end sig { override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -730,12 +703,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier]}) } - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Per-event basis point rate @@ -763,8 +734,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end sig do override @@ -777,8 +747,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -792,12 +761,10 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil) - end + def self.new(bps:, per_unit_maximum: nil); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class BulkBpsConfig < Orb::Internal::Type::BaseModel @@ -812,12 +779,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier]}) } - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Basis points to rate on @@ -836,8 +801,7 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end sig do override.returns( @@ -848,8 +812,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -862,12 +825,10 @@ module Orb params(tiers: T::Array[T.any(Orb::Models::PriceCreateParams::BulkConfig::Tier, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::BulkConfig::Tier]}) } - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Amount per unit @@ -879,12 +840,10 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil) - end + def self.new(unit_amount:, maximum_units: nil); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/price_evaluate_params.rbi b/rbi/lib/orb/models/price_evaluate_params.rbi index 5f74c745..f1b6133c 100644 --- a/rbi/lib/orb/models/price_evaluate_params.rbi +++ b/rbi/lib/orb/models/price_evaluate_params.rbi @@ -57,9 +57,7 @@ module Orb filter: nil, grouping_keys: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -74,8 +72,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/price_evaluate_response.rbi b/rbi/lib/orb/models/price_evaluate_response.rbi index aa77f932..73badb16 100644 --- a/rbi/lib/orb/models/price_evaluate_response.rbi +++ b/rbi/lib/orb/models/price_evaluate_response.rbi @@ -10,12 +10,10 @@ module Orb params(data: T::Array[T.any(Orb::Models::EvaluatePriceGroup, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(data:) - end + def self.new(data:); end sig { override.returns({data: T::Array[Orb::Models::EvaluatePriceGroup]}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/price_fetch_params.rbi b/rbi/lib/orb/models/price_fetch_params.rbi index a5219956..9a099069 100644 --- a/rbi/lib/orb/models/price_fetch_params.rbi +++ b/rbi/lib/orb/models/price_fetch_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/price_list_params.rbi b/rbi/lib/orb/models/price_list_params.rbi index 157287b1..616eb163 100644 --- a/rbi/lib/orb/models/price_list_params.rbi +++ b/rbi/lib/orb/models/price_list_params.rbi @@ -26,14 +26,12 @@ module Orb ) .returns(T.attached_class) end - def self.new(cursor: nil, limit: nil, request_options: {}) - end + def self.new(cursor: nil, limit: nil, request_options: {}); end sig do override.returns({cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOptions}) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/price_update_params.rbi b/rbi/lib/orb/models/price_update_params.rbi index 3f33e26c..5cbddba8 100644 --- a/rbi/lib/orb/models/price_update_params.rbi +++ b/rbi/lib/orb/models/price_update_params.rbi @@ -19,8 +19,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(metadata: nil, request_options: {}) - end + def self.new(metadata: nil, request_options: {}); end sig do override @@ -29,8 +28,7 @@ module Orb request_options: Orb::RequestOptions }) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi b/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi index 5f856b53..4ceeb3b8 100644 --- a/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +++ b/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi @@ -15,12 +15,10 @@ module Orb ) ).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/prices/external_price_id_update_params.rbi b/rbi/lib/orb/models/prices/external_price_id_update_params.rbi index 849da83b..60b7005c 100644 --- a/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +++ b/rbi/lib/orb/models/prices/external_price_id_update_params.rbi @@ -20,8 +20,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(metadata: nil, request_options: {}) - end + def self.new(metadata: nil, request_options: {}); end sig do override @@ -30,8 +29,7 @@ module Orb request_options: Orb::RequestOptions }) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription.rbi b/rbi/lib/orb/models/subscription.rbi index 4b848df8..9ebc3027 100644 --- a/rbi/lib/orb/models/subscription.rbi +++ b/rbi/lib/orb/models/subscription.rbi @@ -88,11 +88,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, - Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, - Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -201,12 +201,12 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, - Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[T.any(Orb::Models::Subscription::FixedFeeQuantitySchedule, Orb::Internal::AnyHash)], @@ -250,9 +250,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -269,11 +267,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, - Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, - Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::Subscription::FixedFeeQuantitySchedule], @@ -291,8 +289,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -340,8 +337,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -361,8 +357,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -416,9 +411,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -433,8 +426,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -486,9 +478,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -503,8 +493,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -556,9 +545,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -573,8 +560,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -632,9 +618,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -650,8 +634,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -703,9 +686,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -720,8 +701,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -730,8 +710,7 @@ module Orb [Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -757,12 +736,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -810,9 +787,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -826,8 +801,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -873,9 +847,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -889,8 +861,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -936,9 +907,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -952,8 +921,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -962,8 +930,7 @@ module Orb [Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -983,14 +950,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1046,8 +1011,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1103,8 +1067,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1258,9 +1221,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1307,8 +1268,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1321,12 +1281,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1343,12 +1301,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1362,8 +1318,7 @@ module Orb UPCOMING = T.let(:upcoming, Orb::Models::Subscription::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::Subscription::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1371,12 +1326,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_cancel_params.rbi b/rbi/lib/orb/models/subscription_cancel_params.rbi index 5b6f3c1f..d901d67d 100644 --- a/rbi/lib/orb/models/subscription_cancel_params.rbi +++ b/rbi/lib/orb/models/subscription_cancel_params.rbi @@ -49,8 +49,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # Determines the timing of subscription cancellation module CancelOption @@ -67,8 +66,7 @@ module Orb T.let(:requested_date, Orb::Models::SubscriptionCancelParams::CancelOption::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionCancelParams::CancelOption::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/subscription_cancel_response.rbi b/rbi/lib/orb/models/subscription_cancel_response.rbi index d377533d..a9c0d903 100644 --- a/rbi/lib/orb/models/subscription_cancel_response.rbi +++ b/rbi/lib/orb/models/subscription_cancel_response.rbi @@ -88,11 +88,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -182,12 +182,12 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[T.any(Orb::Models::SubscriptionCancelResponse::FixedFeeQuantitySchedule, Orb::Internal::AnyHash)], @@ -231,9 +231,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -250,11 +248,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionCancelResponse::FixedFeeQuantitySchedule], @@ -272,8 +270,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -321,8 +318,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -342,8 +338,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -397,9 +392,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -414,8 +407,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -467,9 +459,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -484,8 +474,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -537,9 +526,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -554,8 +541,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -613,9 +599,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -631,8 +615,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -684,9 +667,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -701,8 +682,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -711,8 +691,7 @@ module Orb [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -738,12 +717,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -791,9 +768,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -807,8 +782,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -854,9 +828,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -870,8 +842,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -917,9 +888,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -933,8 +902,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -943,8 +911,7 @@ module Orb [Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -964,14 +931,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1027,8 +992,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1084,8 +1048,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1195,10 +1158,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionCancelResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCancelResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1248,9 +1211,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1297,8 +1258,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1311,12 +1271,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1333,12 +1291,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1353,8 +1309,7 @@ module Orb UPCOMING = T.let(:upcoming, Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1362,12 +1317,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_create_params.rbi b/rbi/lib/orb/models/subscription_create_params.rbi index 7b51a49d..53891441 100644 --- a/rbi/lib/orb/models/subscription_create_params.rbi +++ b/rbi/lib/orb/models/subscription_create_params.rbi @@ -239,9 +239,7 @@ module Orb trial_duration_days: nil, usage_customer_ids: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -281,8 +279,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AddAdjustment < Orb::Internal::Type::BaseModel # The definition of a new adjustment to create and add to the subscription. @@ -330,8 +327,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil) - end + def self.new(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil); end sig do override @@ -350,8 +346,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The definition of a new adjustment to create and add to the subscription. module Adjustment @@ -404,8 +399,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -455,8 +449,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -506,8 +499,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMinimum < Orb::Internal::Type::BaseModel @@ -564,8 +556,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMaximum < Orb::Internal::Type::BaseModel @@ -615,8 +606,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -625,8 +615,7 @@ module Orb [Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::AddAdjustment::Adjustment::NewMaximum] ) end - def self.variants - end + def self.variants; end end end @@ -775,9 +764,7 @@ module Orb price: nil, price_id: nil, start_date: nil - ) - end - + ); end sig do override .returns( @@ -823,8 +810,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AllocationPrice < Orb::Internal::Type::BaseModel # An amount of the currency to allocate to the customer at the specified cadence. @@ -855,8 +841,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:) - end + def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end sig do override @@ -869,8 +854,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence at which to allocate the amount to the customer. module Cadence @@ -907,8 +891,7 @@ module Orb override .returns(T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -953,8 +936,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -981,8 +963,7 @@ module Orb override .returns(T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType::TaggedSymbol]) end - def self.values - end + def self.values; end end end @@ -1166,9 +1147,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit - ) - end - + ); end sig do override .returns( @@ -1196,8 +1175,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -1251,8 +1229,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class UnitConfig < Orb::Internal::Type::BaseModel @@ -1261,12 +1238,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:) - end + def self.new(unit_amount:); end sig { override.returns({unit_amount: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -1291,8 +1266,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1303,8 +1277,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1338,12 +1311,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1369,8 +1341,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1381,8 +1352,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1416,12 +1386,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -1606,9 +1575,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :package - ) - end - + ); end sig do override .returns( @@ -1636,8 +1603,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -1693,8 +1659,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class PackageConfig < Orb::Internal::Type::BaseModel @@ -1708,12 +1673,10 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:) - end + def self.new(package_amount:, package_size:); end sig { override.returns({package_amount: String, package_size: Integer}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -1738,8 +1701,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1750,8 +1712,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1785,12 +1746,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1816,8 +1776,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1828,8 +1787,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1863,12 +1821,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -2049,9 +2006,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :matrix - ) - end - + ); end sig do override .returns( @@ -2079,8 +2034,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -2134,8 +2088,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -2151,7 +2104,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] ) end @@ -2162,16 +2115,15 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -2180,13 +2132,12 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -2205,12 +2156,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -2236,8 +2185,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2248,8 +2196,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2283,12 +2230,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -2314,8 +2260,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2326,8 +2271,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2361,12 +2305,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -2547,9 +2490,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered - ) - end - + ); end sig do override .returns( @@ -2577,8 +2518,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -2632,8 +2572,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class TieredConfig < Orb::Internal::Type::BaseModel @@ -2648,16 +2587,15 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override @@ -2667,8 +2605,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Inclusive tier starting value @@ -2690,14 +2627,12 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil) - end + def self.new(first_unit:, unit_amount:, last_unit: nil); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end - def to_hash - end + def to_hash; end end end @@ -2723,8 +2658,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2735,8 +2669,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2770,12 +2703,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -2801,8 +2733,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2813,8 +2744,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2848,12 +2778,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3038,9 +2967,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_bps - ) - end - + ); end sig do override .returns( @@ -3068,8 +2995,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -3123,12 +3049,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class TieredBpsConfig < Orb::Internal::Type::BaseModel @@ -3137,7 +3062,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] ) end @@ -3146,29 +3071,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Per-event basis point rate @@ -3196,8 +3119,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end sig do override @@ -3210,8 +3132,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -3237,8 +3158,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3249,8 +3169,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3284,12 +3203,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -3315,8 +3233,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3327,8 +3244,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3362,12 +3278,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3548,9 +3463,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bps - ) - end - + ); end sig do override .returns( @@ -3578,8 +3491,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BpsConfig < Orb::Internal::Type::BaseModel # Basis point take rate per event @@ -3591,12 +3503,10 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil) - end + def self.new(bps:, per_unit_maximum: nil); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } - def to_hash - end + def to_hash; end end # The cadence to bill for this price on. @@ -3651,8 +3561,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -3677,8 +3586,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3689,8 +3597,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3724,12 +3631,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -3755,8 +3661,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3767,8 +3672,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3802,12 +3706,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3992,9 +3895,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk_bps - ) - end - + ); end sig do override .returns( @@ -4022,8 +3923,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -4038,16 +3938,15 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override @@ -4057,8 +3956,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Basis points to rate on @@ -4077,8 +3975,7 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end sig do override.returns( @@ -4089,8 +3986,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -4148,8 +4044,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4174,8 +4069,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4186,8 +4080,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4221,12 +4114,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -4252,8 +4144,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4264,8 +4155,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4299,12 +4189,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -4485,9 +4374,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk - ) - end - + ); end sig do override .returns( @@ -4515,8 +4402,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkConfig < Orb::Internal::Type::BaseModel # Bulk tiers for rating based on total usage volume @@ -4530,16 +4416,15 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override @@ -4549,8 +4434,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Amount per unit @@ -4562,12 +4446,10 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil) - end + def self.new(unit_amount:, maximum_units: nil); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -4623,8 +4505,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4649,8 +4530,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4661,8 +4541,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4696,12 +4575,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -4727,8 +4605,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4739,8 +4616,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4774,12 +4650,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -4946,9 +4821,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :threshold_total_amount - ) - end - + ); end sig do override .returns( @@ -4976,8 +4849,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5031,12 +4903,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5061,8 +4932,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5073,8 +4943,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5108,12 +4977,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5139,8 +5007,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5151,8 +5018,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5186,12 +5052,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5358,9 +5223,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_package - ) - end - + ); end sig do override .returns( @@ -5388,8 +5251,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5443,12 +5305,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5473,8 +5334,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5485,8 +5345,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5520,12 +5379,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5551,8 +5409,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5563,8 +5420,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5598,12 +5454,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5770,9 +5625,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_with_minimum - ) - end - + ); end sig do override .returns( @@ -5800,8 +5653,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5855,12 +5707,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5885,8 +5736,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5897,8 +5747,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5932,12 +5781,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5963,8 +5811,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5975,8 +5822,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6010,12 +5856,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -6182,9 +6027,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit_with_percent - ) - end - + ); end sig do override .returns( @@ -6212,8 +6055,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -6267,12 +6109,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6297,8 +6138,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6309,8 +6149,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6344,12 +6183,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6375,8 +6213,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6387,8 +6224,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6422,12 +6258,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -6594,9 +6429,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :package_with_allocation - ) - end - + ); end sig do override .returns( @@ -6624,8 +6457,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -6679,12 +6511,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6709,8 +6540,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6721,8 +6551,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6756,12 +6585,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6787,8 +6615,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6799,8 +6626,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6834,12 +6660,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7006,9 +6831,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_with_proration - ) - end - + ); end sig do override .returns( @@ -7036,8 +6859,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7091,12 +6913,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7121,8 +6942,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7133,8 +6953,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7168,12 +6987,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -7199,8 +7017,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7211,8 +7028,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7246,12 +7062,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7418,9 +7233,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit_with_proration - ) - end - + ); end sig do override .returns( @@ -7448,8 +7261,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7503,12 +7315,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7533,8 +7344,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7545,8 +7355,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7580,12 +7389,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -7611,8 +7419,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7623,8 +7430,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7658,12 +7464,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7830,9 +7635,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_allocation - ) - end - + ); end sig do override .returns( @@ -7860,8 +7663,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7915,12 +7717,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7945,8 +7746,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7957,8 +7757,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7992,12 +7791,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8023,8 +7821,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8035,8 +7832,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8070,12 +7866,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -8242,9 +8037,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_with_prorated_minimum - ) - end - + ); end sig do override .returns( @@ -8272,8 +8065,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -8327,12 +8119,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8357,8 +8148,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8369,8 +8159,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8404,12 +8193,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8435,8 +8223,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8447,8 +8234,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8482,12 +8268,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -8654,9 +8439,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk_with_proration - ) - end - + ); end sig do override .returns( @@ -8684,8 +8467,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -8739,12 +8521,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8769,8 +8550,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8781,8 +8561,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8816,12 +8595,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8847,8 +8625,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8859,8 +8636,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8894,12 +8670,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9066,9 +8841,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_unit_pricing - ) - end - + ); end sig do override .returns( @@ -9096,8 +8869,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9151,12 +8923,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9181,8 +8952,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9193,8 +8963,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9228,12 +8997,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9259,8 +9027,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9271,8 +9038,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9306,12 +9072,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9478,9 +9243,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing - ) - end - + ); end sig do override .returns( @@ -9508,8 +9271,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9563,12 +9325,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9593,8 +9354,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9605,8 +9365,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9640,12 +9399,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9671,8 +9429,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9683,8 +9440,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9718,12 +9474,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9890,9 +9645,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :cumulative_grouped_bulk - ) - end - + ); end sig do override .returns( @@ -9920,8 +9673,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9975,12 +9727,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10005,8 +9756,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10017,8 +9767,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10052,12 +9801,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -10083,8 +9831,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10095,8 +9842,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10130,12 +9876,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -10302,9 +10047,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :max_group_tiered_package - ) - end - + ); end sig do override .returns( @@ -10332,8 +10075,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -10387,12 +10129,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10417,8 +10158,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10429,8 +10169,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10464,12 +10203,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -10495,8 +10233,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10507,8 +10244,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10542,12 +10278,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -10714,9 +10449,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_with_metered_minimum - ) - end - + ); end sig do override .returns( @@ -10744,8 +10477,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -10799,12 +10531,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10829,8 +10560,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10841,8 +10571,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10876,12 +10605,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -10907,8 +10635,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10919,8 +10646,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10954,12 +10680,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -11126,9 +10851,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :matrix_with_display_name - ) - end - + ); end sig do override .returns( @@ -11156,8 +10879,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -11211,12 +10933,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11241,8 +10962,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11253,8 +10973,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11288,12 +11007,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -11319,8 +11037,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11331,8 +11048,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11366,12 +11082,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -11538,9 +11253,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_tiered_package - ) - end - + ); end sig do override .returns( @@ -11568,8 +11281,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -11623,12 +11335,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11653,8 +11364,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11665,8 +11375,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11700,12 +11409,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -11731,8 +11439,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11743,8 +11450,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11778,12 +11484,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -11794,8 +11499,7 @@ module Orb [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice] ) end - def self.variants - end + def self.variants; end end end @@ -11821,12 +11525,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module ExternalMarketplace @@ -11841,8 +11543,7 @@ module Orb AZURE = T.let(:azure, Orb::Models::SubscriptionCreateParams::ExternalMarketplace::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionCreateParams::ExternalMarketplace::TaggedSymbol]) } - def self.values - end + def self.values; end end class RemoveAdjustment < Orb::Internal::Type::BaseModel @@ -11851,12 +11552,10 @@ module Orb attr_accessor :adjustment_id sig { params(adjustment_id: String).returns(T.attached_class) } - def self.new(adjustment_id:) - end + def self.new(adjustment_id:); end sig { override.returns({adjustment_id: String}) } - def to_hash - end + def to_hash; end end class RemovePrice < Orb::Internal::Type::BaseModel @@ -11871,12 +11570,10 @@ module Orb sig do params(external_price_id: T.nilable(String), price_id: T.nilable(String)).returns(T.attached_class) end - def self.new(external_price_id: nil, price_id: nil) - end + def self.new(external_price_id: nil, price_id: nil); end sig { override.returns({external_price_id: T.nilable(String), price_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class ReplaceAdjustment < Orb::Internal::Type::BaseModel @@ -11912,8 +11609,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, replaces_adjustment_id:) - end + def self.new(adjustment:, replaces_adjustment_id:); end sig do override @@ -11930,8 +11626,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The definition of a new adjustment to create and add to the subscription. module Adjustment @@ -11984,8 +11679,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -12035,8 +11729,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -12086,8 +11779,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMinimum < Orb::Internal::Type::BaseModel @@ -12144,8 +11836,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMaximum < Orb::Internal::Type::BaseModel @@ -12195,8 +11886,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -12205,8 +11895,7 @@ module Orb [Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionCreateParams::ReplaceAdjustment::Adjustment::NewMaximum] ) end - def self.variants - end + def self.variants; end end end @@ -12349,9 +12038,7 @@ module Orb minimum_amount: nil, price: nil, price_id: nil - ) - end - + ); end sig do override .returns( @@ -12396,8 +12083,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AllocationPrice < Orb::Internal::Type::BaseModel # An amount of the currency to allocate to the customer at the specified cadence. @@ -12428,8 +12114,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:) - end + def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end sig do override @@ -12442,8 +12127,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence at which to allocate the amount to the customer. module Cadence @@ -12497,8 +12181,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -12543,8 +12226,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -12576,8 +12258,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount::DiscountType::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -12761,9 +12442,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit - ) - end - + ); end sig do override .returns( @@ -12791,8 +12470,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -12846,12 +12524,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class UnitConfig < Orb::Internal::Type::BaseModel @@ -12860,12 +12537,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:) - end + def self.new(unit_amount:); end sig { override.returns({unit_amount: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -12890,8 +12565,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -12902,8 +12576,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -12937,12 +12610,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -12968,8 +12640,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -12980,8 +12651,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -13015,12 +12685,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -13205,9 +12874,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :package - ) - end - + ); end sig do override .returns( @@ -13235,8 +12902,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -13290,12 +12956,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class PackageConfig < Orb::Internal::Type::BaseModel @@ -13309,12 +12974,10 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:) - end + def self.new(package_amount:, package_size:); end sig { override.returns({package_amount: String, package_size: Integer}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -13339,8 +13002,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13351,8 +13013,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -13386,12 +13047,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -13417,8 +13077,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13429,8 +13088,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -13464,12 +13122,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -13654,9 +13311,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :matrix - ) - end - + ); end sig do override .returns( @@ -13684,8 +13339,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -13739,12 +13393,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -13760,7 +13413,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] ) end @@ -13771,16 +13424,15 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -13789,13 +13441,12 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -13814,12 +13465,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -13845,8 +13494,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13857,8 +13505,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -13892,12 +13539,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -13923,8 +13569,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13935,8 +13580,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -13970,12 +13614,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -14160,9 +13803,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered - ) - end - + ); end sig do override .returns( @@ -14190,8 +13831,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -14245,12 +13885,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class TieredConfig < Orb::Internal::Type::BaseModel @@ -14265,16 +13904,15 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override @@ -14284,8 +13922,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Inclusive tier starting value @@ -14307,14 +13944,12 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil) - end + def self.new(first_unit:, unit_amount:, last_unit: nil); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end - def to_hash - end + def to_hash; end end end @@ -14340,8 +13975,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14352,8 +13986,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -14387,12 +14020,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -14418,8 +14050,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14430,8 +14061,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -14465,12 +14095,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -14655,9 +14284,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_bps - ) - end - + ); end sig do override .returns( @@ -14685,8 +14312,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -14740,12 +14366,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class TieredBpsConfig < Orb::Internal::Type::BaseModel @@ -14754,7 +14379,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] ) end @@ -14763,29 +14388,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Per-event basis point rate @@ -14813,8 +14436,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end sig do override @@ -14827,8 +14449,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -14854,8 +14475,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14866,8 +14486,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -14901,12 +14520,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -14932,8 +14550,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14944,8 +14561,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -14979,12 +14595,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -15165,9 +14780,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bps - ) - end - + ); end sig do override .returns( @@ -15195,8 +14808,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BpsConfig < Orb::Internal::Type::BaseModel # Basis point take rate per event @@ -15208,12 +14820,10 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil) - end + def self.new(bps:, per_unit_maximum: nil); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } - def to_hash - end + def to_hash; end end # The cadence to bill for this price on. @@ -15270,8 +14880,7 @@ module Orb T::Array[Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -15296,8 +14905,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15308,8 +14916,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -15343,12 +14950,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -15374,8 +14980,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15386,8 +14991,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -15421,12 +15025,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -15611,9 +15214,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk_bps - ) - end - + ); end sig do override .returns( @@ -15641,8 +15242,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -15650,7 +15250,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier ] ) end @@ -15659,29 +15259,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Basis points to rate on @@ -15700,8 +15298,7 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end sig do override.returns( @@ -15712,8 +15309,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -15769,12 +15365,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -15799,8 +15394,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15811,8 +15405,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -15846,12 +15439,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -15877,8 +15469,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15889,8 +15480,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -15924,12 +15514,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -16110,9 +15699,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk - ) - end - + ); end sig do override .returns( @@ -16140,8 +15727,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkConfig < Orb::Internal::Type::BaseModel # Bulk tiers for rating based on total usage volume @@ -16154,17 +15740,16 @@ module Orb sig do params( - tiers: T::Array[ - T.any( - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier, - Orb::Internal::AnyHash - ) + tiers: T::Array[ + T.any( + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override @@ -16174,8 +15759,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Amount per unit @@ -16187,12 +15771,10 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil) - end + def self.new(unit_amount:, maximum_units: nil); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -16248,12 +15830,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -16278,8 +15859,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -16290,8 +15870,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16325,12 +15904,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -16356,8 +15934,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -16368,8 +15945,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16403,12 +15979,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -16575,9 +16150,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :threshold_total_amount - ) - end - + ); end sig do override .returns( @@ -16605,8 +16178,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -16660,12 +16232,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -16690,8 +16261,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -16702,8 +16272,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16737,12 +16306,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -16768,8 +16336,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -16780,8 +16347,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16815,12 +16381,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -16987,9 +16552,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_package - ) - end - + ); end sig do override .returns( @@ -17017,8 +16580,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -17072,12 +16634,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -17102,8 +16663,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -17114,8 +16674,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -17149,12 +16708,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -17180,8 +16738,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -17192,8 +16749,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -17227,12 +16783,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -17399,9 +16954,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_with_minimum - ) - end - + ); end sig do override .returns( @@ -17429,8 +16982,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -17484,12 +17036,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -17514,8 +17065,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -17526,8 +17076,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -17561,12 +17110,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -17592,8 +17140,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -17604,8 +17151,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -17639,12 +17185,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -17811,9 +17356,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit_with_percent - ) - end - + ); end sig do override .returns( @@ -17841,8 +17384,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -17896,12 +17438,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -17926,8 +17467,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -17938,8 +17478,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -17973,12 +17512,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -18004,8 +17542,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18016,8 +17553,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18051,12 +17587,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -18223,9 +17758,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :package_with_allocation - ) - end - + ); end sig do override .returns( @@ -18253,8 +17786,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -18308,12 +17840,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -18338,8 +17869,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18350,8 +17880,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18385,12 +17914,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -18416,8 +17944,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18428,8 +17955,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18463,12 +17989,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -18635,9 +18160,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_with_proration - ) - end - + ); end sig do override .returns( @@ -18665,8 +18188,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -18720,12 +18242,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -18750,8 +18271,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18762,8 +18282,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18797,12 +18316,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -18828,8 +18346,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18840,8 +18357,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18875,12 +18391,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -19047,9 +18562,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit_with_proration - ) - end - + ); end sig do override .returns( @@ -19077,8 +18590,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -19132,12 +18644,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -19162,8 +18673,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19174,8 +18684,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -19209,12 +18718,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -19240,8 +18748,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19252,8 +18759,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -19287,12 +18793,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -19459,9 +18964,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_allocation - ) - end - + ); end sig do override .returns( @@ -19489,8 +18992,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -19544,12 +19046,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -19574,8 +19075,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19586,8 +19086,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -19621,12 +19120,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -19652,8 +19150,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19664,8 +19161,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -19699,12 +19195,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -19871,9 +19366,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_with_prorated_minimum - ) - end - + ); end sig do override .returns( @@ -19901,8 +19394,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -19956,12 +19448,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -19986,8 +19477,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19998,8 +19488,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20033,12 +19522,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -20064,8 +19552,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20076,8 +19563,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20111,12 +19597,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -20283,9 +19768,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk_with_proration - ) - end - + ); end sig do override .returns( @@ -20313,8 +19796,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -20368,12 +19850,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -20398,8 +19879,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20410,8 +19890,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20445,12 +19924,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -20476,8 +19954,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20488,8 +19965,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20523,12 +19999,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -20695,9 +20170,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_unit_pricing - ) - end - + ); end sig do override .returns( @@ -20725,8 +20198,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -20780,12 +20252,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -20810,8 +20281,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20822,8 +20292,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20857,12 +20326,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -20888,8 +20356,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20900,8 +20367,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20935,12 +20401,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -21107,9 +20572,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing - ) - end - + ); end sig do override .returns( @@ -21137,8 +20600,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -21192,12 +20654,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -21222,8 +20683,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -21234,8 +20694,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21269,12 +20728,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -21300,8 +20758,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -21312,8 +20769,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21347,12 +20803,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -21519,9 +20974,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :cumulative_grouped_bulk - ) - end - + ); end sig do override .returns( @@ -21549,8 +21002,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -21604,12 +21056,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -21634,8 +21085,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -21646,8 +21096,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21681,12 +21130,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -21712,8 +21160,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -21724,8 +21171,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21759,12 +21205,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -21931,9 +21376,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :max_group_tiered_package - ) - end - + ); end sig do override .returns( @@ -21961,8 +21404,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -22016,12 +21458,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -22046,8 +21487,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22058,8 +21498,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22093,12 +21532,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -22124,8 +21562,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22136,8 +21573,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22171,12 +21607,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -22343,9 +21778,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_with_metered_minimum - ) - end - + ); end sig do override .returns( @@ -22373,8 +21806,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -22428,12 +21860,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -22458,8 +21889,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22470,8 +21900,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22505,12 +21934,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -22536,8 +21964,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22548,8 +21975,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22583,12 +22009,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -22755,9 +22180,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :matrix_with_display_name - ) - end - + ); end sig do override .returns( @@ -22785,8 +22208,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -22840,12 +22262,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -22870,8 +22291,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22882,8 +22302,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22917,12 +22336,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -22948,8 +22366,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22960,8 +22377,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22995,12 +22411,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -23167,9 +22582,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_tiered_package - ) - end - + ); end sig do override .returns( @@ -23197,8 +22610,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -23252,12 +22664,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -23282,8 +22693,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -23294,8 +22704,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -23329,12 +22738,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -23360,8 +22768,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -23372,8 +22779,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -23407,12 +22813,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -23423,8 +22828,7 @@ module Orb [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/subscription_create_response.rbi b/rbi/lib/orb/models/subscription_create_response.rbi index 24290f71..ac29db7e 100644 --- a/rbi/lib/orb/models/subscription_create_response.rbi +++ b/rbi/lib/orb/models/subscription_create_response.rbi @@ -88,11 +88,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -182,12 +182,12 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[T.any(Orb::Models::SubscriptionCreateResponse::FixedFeeQuantitySchedule, Orb::Internal::AnyHash)], @@ -231,9 +231,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -250,11 +248,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionCreateResponse::FixedFeeQuantitySchedule], @@ -272,8 +270,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -321,8 +318,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -342,8 +338,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -397,9 +392,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -414,8 +407,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -467,9 +459,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -484,8 +474,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -537,9 +526,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -554,8 +541,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -613,9 +599,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -631,8 +615,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -684,9 +667,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -701,8 +682,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -711,8 +691,7 @@ module Orb [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -738,12 +717,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -791,9 +768,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -807,8 +782,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -854,9 +828,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -870,8 +842,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -917,9 +888,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -933,8 +902,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -943,8 +911,7 @@ module Orb [Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -964,14 +931,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1027,8 +992,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1084,8 +1048,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1195,10 +1158,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionCreateResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionCreateResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1248,9 +1211,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1297,8 +1258,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1311,12 +1271,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1333,12 +1291,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1353,8 +1309,7 @@ module Orb UPCOMING = T.let(:upcoming, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1362,12 +1317,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_fetch_costs_params.rbi b/rbi/lib/orb/models/subscription_fetch_costs_params.rbi index 81ad6e26..500772f6 100644 --- a/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_costs_params.rbi @@ -56,8 +56,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # Controls whether Orb returns cumulative costs since the start of the billing # period, or incremental day-by-day costs. If your customer has minimums or @@ -74,8 +73,7 @@ module Orb CUMULATIVE = T.let(:cumulative, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/subscription_fetch_costs_response.rbi b/rbi/lib/orb/models/subscription_fetch_costs_response.rbi index b0b47da1..d2882a03 100644 --- a/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +++ b/rbi/lib/orb/models/subscription_fetch_costs_response.rbi @@ -10,12 +10,10 @@ module Orb params(data: T::Array[T.any(Orb::Models::SubscriptionFetchCostsResponse::Data, Orb::Internal::AnyHash)]) .returns(T.attached_class) end - def self.new(data:) - end + def self.new(data:); end sig { override.returns({data: T::Array[Orb::Models::SubscriptionFetchCostsResponse::Data]}) } - def to_hash - end + def to_hash; end class Data < Orb::Internal::Type::BaseModel sig { returns(T::Array[Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost]) } @@ -45,8 +43,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:) - end + def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end sig do override @@ -60,8 +57,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class PerPriceCost < Orb::Internal::Type::BaseModel # The price object @@ -157,8 +153,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(price:, price_id:, subtotal:, total:, quantity: nil) - end + def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end sig do override @@ -201,8 +196,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_fetch_params.rbi b/rbi/lib/orb/models/subscription_fetch_params.rbi index fe752a4c..5b896780 100644 --- a/rbi/lib/orb/models/subscription_fetch_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi b/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi index cc94aa28..4c3f0092 100644 --- a/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi @@ -50,9 +50,7 @@ module Orb start_date_lt: nil, start_date_lte: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -67,8 +65,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi b/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi index 7025ee21..62ab281b 100644 --- a/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +++ b/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi @@ -27,8 +27,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(created_at:, end_date:, plan:, start_date:) - end + def self.new(created_at:, end_date:, plan:, start_date:); end sig do override @@ -41,8 +40,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Plan < Orb::Internal::Type::BaseModel sig { returns(T.nilable(String)) } @@ -61,8 +59,7 @@ module Orb params(id: T.nilable(String), external_plan_id: T.nilable(String), name: T.nilable(String)) .returns(T.attached_class) end - def self.new(id:, external_plan_id:, name:) - end + def self.new(id:, external_plan_id:, name:); end sig do override.returns( @@ -73,8 +70,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_fetch_usage_params.rbi b/rbi/lib/orb/models/subscription_fetch_usage_params.rbi index e6349943..4e281d86 100644 --- a/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_usage_params.rbi @@ -75,9 +75,7 @@ module Orb timeframe_start: nil, view_mode: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -96,8 +94,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # This determines the windowing of usage reporting. module Granularity @@ -110,8 +107,7 @@ module Orb DAY = T.let(:day, Orb::Models::SubscriptionFetchUsageParams::Granularity::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionFetchUsageParams::Granularity::TaggedSymbol]) } - def self.values - end + def self.values; end end # Controls whether Orb returns cumulative usage since the start of the billing @@ -129,8 +125,7 @@ module Orb CUMULATIVE = T.let(:cumulative, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/subscription_list_params.rbi b/rbi/lib/orb/models/subscription_list_params.rbi index c05548b9..b689d861 100644 --- a/rbi/lib/orb/models/subscription_list_params.rbi +++ b/rbi/lib/orb/models/subscription_list_params.rbi @@ -65,9 +65,7 @@ module Orb limit: nil, status: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -85,8 +83,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Status extend Orb::Internal::Type::Enum @@ -100,8 +97,7 @@ module Orb UPCOMING = T.let(:upcoming, Orb::Models::SubscriptionListParams::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionListParams::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/subscription_price_intervals_params.rbi b/rbi/lib/orb/models/subscription_price_intervals_params.rbi index 3837e0bf..9c5100ab 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_params.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_params.rbi @@ -74,9 +74,7 @@ module Orb edit: nil, edit_adjustments: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -90,8 +88,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Add < Orb::Internal::Type::BaseModel # The start date of the price interval. This is the date that the price will start @@ -118,11 +115,11 @@ module Orb returns( T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::AmountDiscountCreationParams, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::AmountDiscountCreationParams, + Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams, + Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams + ) ] ) ) @@ -223,12 +220,12 @@ module Orb ), discounts: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::AmountDiscountCreationParams, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::AmountDiscountCreationParams, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams, + Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams + ) ] ), end_date: T.nilable(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol)), @@ -236,10 +233,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), maximum_amount: T.nilable(Float), @@ -295,9 +292,7 @@ module Orb price: nil, price_id: nil, usage_customer_ids: nil - ) - end - + ); end sig do override .returns( @@ -306,11 +301,11 @@ module Orb allocation_price: T.nilable(Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice), discounts: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::AmountDiscountCreationParams, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams, - Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::AmountDiscountCreationParams, + Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams, + Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams + ) ] ), end_date: T.nilable(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol)), @@ -356,8 +351,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The start date of the price interval. This is the date that the price will start # billing on the subscription. @@ -365,8 +359,7 @@ module Orb extend Orb::Internal::Type::Union sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } - def self.variants - end + def self.variants; end end class AllocationPrice < Orb::Internal::Type::BaseModel @@ -398,8 +391,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:) - end + def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end sig do override @@ -412,8 +404,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence at which to allocate the amount to the customer. module Cadence @@ -461,8 +452,7 @@ module Orb T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -478,12 +468,10 @@ module Orb attr_accessor :discount_type sig { params(amount_discount: Float, discount_type: Symbol).returns(T.attached_class) } - def self.new(amount_discount:, discount_type: :amount) - end + def self.new(amount_discount:, discount_type: :amount); end sig { override.returns({amount_discount: Float, discount_type: Symbol}) } - def to_hash - end + def to_hash; end end class PercentageDiscountCreationParams < Orb::Internal::Type::BaseModel @@ -496,12 +484,10 @@ module Orb attr_accessor :percentage_discount sig { params(percentage_discount: Float, discount_type: Symbol).returns(T.attached_class) } - def self.new(percentage_discount:, discount_type: :percentage) - end + def self.new(percentage_discount:, discount_type: :percentage); end sig { override.returns({discount_type: Symbol, percentage_discount: Float}) } - def to_hash - end + def to_hash; end end class UsageDiscountCreationParams < Orb::Internal::Type::BaseModel @@ -514,12 +500,10 @@ module Orb attr_accessor :usage_discount sig { params(usage_discount: Float, discount_type: Symbol).returns(T.attached_class) } - def self.new(usage_discount:, discount_type: :usage) - end + def self.new(usage_discount:, discount_type: :usage); end sig { override.returns({discount_type: Symbol, usage_discount: Float}) } - def to_hash - end + def to_hash; end end sig do @@ -528,8 +512,7 @@ module Orb [Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::AmountDiscountCreationParams, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::PercentageDiscountCreationParams, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::UsageDiscountCreationParams] ) end - def self.variants - end + def self.variants; end end # The end date of the price interval. This is the date that the price will stop @@ -538,8 +521,7 @@ module Orb extend Orb::Internal::Type::Union sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } - def self.variants - end + def self.variants; end end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel @@ -552,12 +534,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, quantity:) - end + def self.new(effective_date:, quantity:); end sig { override.returns({effective_date: Time, quantity: Integer}) } - def to_hash - end + def to_hash; end end # The definition of a new price to create and add to the subscription. @@ -732,9 +712,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit - ) - end - + ); end sig do override .returns( @@ -761,8 +739,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -816,8 +793,7 @@ module Orb T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class UnitConfig < Orb::Internal::Type::BaseModel @@ -826,12 +802,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:) - end + def self.new(unit_amount:); end sig { override.returns({unit_amount: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -856,8 +830,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -868,8 +841,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -903,12 +875,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -934,8 +905,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -946,8 +916,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -981,12 +950,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -1159,9 +1127,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :package - ) - end - + ); end sig do override .returns( @@ -1188,8 +1154,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -1243,8 +1208,7 @@ module Orb T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class PackageConfig < Orb::Internal::Type::BaseModel @@ -1258,12 +1222,10 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:) - end + def self.new(package_amount:, package_size:); end sig { override.returns({package_amount: String, package_size: Integer}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -1288,8 +1250,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1300,8 +1261,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1335,12 +1295,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1366,8 +1325,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1378,8 +1336,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1413,12 +1370,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -1591,9 +1547,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix - ) - end - + ); end sig do override .returns( @@ -1620,8 +1574,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -1675,8 +1628,7 @@ module Orb T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -1692,7 +1644,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue ] ) end @@ -1703,16 +1655,15 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -1721,13 +1672,12 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::MatrixConfig::MatrixValue ] } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -1746,12 +1696,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -1777,8 +1725,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1789,8 +1736,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1824,12 +1770,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1855,8 +1800,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1867,8 +1811,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1902,12 +1845,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -2084,9 +2026,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_allocation - ) - end - + ); end sig do override .returns( @@ -2113,8 +2053,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -2168,12 +2107,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel @@ -2193,7 +2131,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue ] ) end @@ -2205,16 +2143,15 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -2224,13 +2161,12 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::MatrixWithAllocationConfig::MatrixValue ] } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -2249,12 +2185,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -2280,8 +2214,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2292,8 +2225,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2327,12 +2259,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -2358,8 +2289,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2370,8 +2300,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2405,12 +2334,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -2583,9 +2511,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered - ) - end - + ); end sig do override .returns( @@ -2612,8 +2538,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -2667,8 +2592,7 @@ module Orb T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class TieredConfig < Orb::Internal::Type::BaseModel @@ -2683,16 +2607,15 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::TieredConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::TieredConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override @@ -2702,8 +2625,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Inclusive tier starting value @@ -2725,14 +2647,12 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil) - end + def self.new(first_unit:, unit_amount:, last_unit: nil); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end - def to_hash - end + def to_hash; end end end @@ -2758,8 +2678,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2770,8 +2689,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2805,12 +2723,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -2836,8 +2753,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2848,8 +2764,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2883,12 +2798,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3065,9 +2979,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps - ) - end - + ); end sig do override .returns( @@ -3094,8 +3006,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -3149,12 +3060,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class TieredBpsConfig < Orb::Internal::Type::BaseModel @@ -3163,7 +3073,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier ] ) end @@ -3172,29 +3082,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::TieredBpsConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Per-event basis point rate @@ -3222,8 +3130,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end sig do override @@ -3236,8 +3143,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -3263,8 +3169,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3275,8 +3180,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3310,12 +3214,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -3341,8 +3244,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3353,8 +3255,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3388,12 +3289,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3562,9 +3462,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps - ) - end - + ); end sig do override .returns( @@ -3591,8 +3489,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BpsConfig < Orb::Internal::Type::BaseModel # Basis point take rate per event @@ -3604,12 +3501,10 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil) - end + def self.new(bps:, per_unit_maximum: nil); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } - def to_hash - end + def to_hash; end end # The cadence to bill for this price on. @@ -3664,8 +3559,7 @@ module Orb T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -3690,8 +3584,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3702,8 +3595,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3737,12 +3629,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -3768,8 +3659,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3780,8 +3670,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3815,12 +3704,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3993,9 +3881,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps - ) - end - + ); end sig do override .returns( @@ -4022,8 +3908,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -4038,16 +3923,15 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override @@ -4057,8 +3941,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Basis points to rate on @@ -4077,8 +3960,7 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end sig do override.returns( @@ -4089,8 +3971,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -4146,8 +4027,7 @@ module Orb T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4172,8 +4052,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4184,8 +4063,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4219,12 +4097,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -4250,8 +4127,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4262,8 +4138,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4297,12 +4172,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -4475,9 +4349,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk - ) - end - + ); end sig do override .returns( @@ -4504,8 +4376,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkConfig < Orb::Internal::Type::BaseModel # Bulk tiers for rating based on total usage volume @@ -4519,16 +4390,15 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BulkConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BulkConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override @@ -4538,8 +4408,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Amount per unit @@ -4551,12 +4420,10 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil) - end + def self.new(unit_amount:, maximum_units: nil); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -4612,8 +4479,7 @@ module Orb T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4638,8 +4504,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4650,8 +4515,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4685,12 +4549,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -4716,8 +4579,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4728,8 +4590,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4763,12 +4624,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -4927,9 +4787,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount - ) - end - + ); end sig do override .returns( @@ -4956,8 +4814,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5011,12 +4868,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5041,8 +4897,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5053,8 +4908,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5088,12 +4942,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5119,8 +4972,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5131,8 +4983,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5166,12 +5017,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5330,9 +5180,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package - ) - end - + ); end sig do override .returns( @@ -5359,8 +5207,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5414,12 +5261,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5444,8 +5290,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5456,8 +5301,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5491,12 +5335,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5522,8 +5365,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5534,8 +5376,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5569,12 +5410,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5733,9 +5573,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered - ) - end - + ); end sig do override .returns( @@ -5762,8 +5600,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5817,12 +5654,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5847,8 +5683,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5859,8 +5694,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5894,12 +5728,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5925,8 +5758,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5937,8 +5769,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5972,12 +5803,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -6136,9 +5966,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :max_group_tiered_package - ) - end - + ); end sig do override .returns( @@ -6165,8 +5993,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -6220,12 +6047,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6250,8 +6076,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6262,8 +6087,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6297,12 +6121,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6328,8 +6151,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6340,8 +6162,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6375,12 +6196,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -6539,9 +6359,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum - ) - end - + ); end sig do override .returns( @@ -6568,8 +6386,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -6623,12 +6440,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6653,8 +6469,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6665,8 +6480,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6700,12 +6514,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6731,8 +6544,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6743,8 +6555,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6778,12 +6589,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -6942,9 +6752,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation - ) - end - + ); end sig do override .returns( @@ -6971,8 +6779,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7026,12 +6833,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7056,8 +6862,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7068,8 +6873,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7103,12 +6907,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -7134,8 +6937,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7146,8 +6948,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7181,12 +6982,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7345,9 +7145,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package_with_minimum - ) - end - + ); end sig do override .returns( @@ -7374,8 +7172,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7429,12 +7226,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7459,8 +7255,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7471,8 +7266,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7506,12 +7300,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -7537,8 +7330,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7549,8 +7341,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7584,12 +7375,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7748,9 +7538,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent - ) - end - + ); end sig do override .returns( @@ -7777,8 +7565,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7832,12 +7619,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7862,8 +7648,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7874,8 +7659,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7909,12 +7693,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -7940,8 +7723,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7952,8 +7734,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7987,12 +7768,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -8151,9 +7931,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration - ) - end - + ); end sig do override .returns( @@ -8180,8 +7958,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -8235,12 +8012,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8265,8 +8041,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8277,8 +8052,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8312,12 +8086,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8343,8 +8116,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8355,8 +8127,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8390,12 +8161,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -8554,9 +8324,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration - ) - end - + ); end sig do override .returns( @@ -8583,8 +8351,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -8638,12 +8405,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8668,8 +8434,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8680,8 +8445,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8715,12 +8479,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8746,8 +8509,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8758,8 +8520,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8793,12 +8554,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -8957,9 +8717,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation - ) - end - + ); end sig do override .returns( @@ -8986,8 +8744,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9041,12 +8798,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9071,8 +8827,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9083,8 +8838,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9118,12 +8872,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9149,8 +8902,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9161,8 +8913,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9196,12 +8947,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9360,9 +9110,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_prorated_minimum - ) - end - + ); end sig do override .returns( @@ -9389,8 +9137,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9444,12 +9191,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9474,8 +9220,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9486,8 +9231,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9521,12 +9265,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9552,8 +9295,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9564,8 +9306,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9599,12 +9340,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9763,9 +9503,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_metered_minimum - ) - end - + ); end sig do override .returns( @@ -9792,8 +9530,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9847,12 +9584,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9877,8 +9613,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9889,8 +9624,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9924,12 +9658,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9955,8 +9688,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9967,8 +9699,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10002,12 +9733,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -10166,9 +9896,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_display_name - ) - end - + ); end sig do override .returns( @@ -10195,8 +9923,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -10250,12 +9977,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10280,8 +10006,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10292,8 +10017,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10327,12 +10051,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -10358,8 +10081,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10370,8 +10092,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10405,12 +10126,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -10569,9 +10289,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration - ) - end - + ); end sig do override .returns( @@ -10598,8 +10316,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -10653,12 +10370,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10683,8 +10399,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10695,8 +10410,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10730,12 +10444,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -10761,8 +10474,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10773,8 +10485,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10808,12 +10519,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -10972,9 +10682,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package - ) - end - + ); end sig do override .returns( @@ -11001,8 +10709,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -11056,12 +10763,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11086,8 +10792,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11098,8 +10803,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11133,12 +10837,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -11164,8 +10867,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11176,8 +10878,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11211,12 +10912,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -11375,9 +11075,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_unit_pricing - ) - end - + ); end sig do override .returns( @@ -11404,8 +11102,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -11459,12 +11156,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11489,8 +11185,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11501,8 +11196,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11536,12 +11230,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -11567,8 +11260,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11579,8 +11271,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11614,12 +11305,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -11778,9 +11468,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_tiered_pricing - ) - end - + ); end sig do override .returns( @@ -11807,8 +11495,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -11862,12 +11549,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11892,8 +11578,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11904,8 +11589,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11939,12 +11623,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -11970,8 +11653,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11982,8 +11664,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -12017,12 +11698,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -12181,9 +11861,7 @@ module Orb invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk - ) - end - + ); end sig do override .returns( @@ -12210,8 +11888,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -12265,12 +11942,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -12295,8 +11971,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -12307,8 +11982,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -12342,12 +12016,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -12373,8 +12046,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -12385,8 +12057,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -12420,12 +12091,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -12436,8 +12106,7 @@ module Orb [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice] ) end - def self.variants - end + def self.variants; end end end @@ -12485,8 +12154,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, start_date:, end_date: nil) - end + def self.new(adjustment:, start_date:, end_date: nil); end sig do override @@ -12504,8 +12172,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The definition of a new adjustment to create and add to the subscription. module Adjustment @@ -12558,8 +12225,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -12609,8 +12275,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -12660,8 +12325,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMinimum < Orb::Internal::Type::BaseModel @@ -12718,8 +12382,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMaximum < Orb::Internal::Type::BaseModel @@ -12769,8 +12432,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -12779,8 +12441,7 @@ module Orb [Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::NewMaximum] ) end - def self.variants - end + def self.variants; end end # The start date of the adjustment interval. This is the date that the adjustment @@ -12791,8 +12452,7 @@ module Orb extend Orb::Internal::Type::Union sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } - def self.variants - end + def self.variants; end end # The end date of the adjustment interval. This is the date that the adjustment @@ -12803,8 +12463,7 @@ module Orb extend Orb::Internal::Type::Union sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } - def self.variants - end + def self.variants; end end end @@ -12866,10 +12525,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), start_date: T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol), @@ -12885,9 +12544,7 @@ module Orb fixed_fee_quantity_transitions: nil, start_date: nil, usage_customer_ids: nil - ) - end - + ); end sig do override .returns( @@ -12902,8 +12559,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The updated end date of this price interval. If not specified, the start date # will not be updated. @@ -12911,8 +12567,7 @@ module Orb extend Orb::Internal::Type::Union sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } - def self.variants - end + def self.variants; end end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel @@ -12925,12 +12580,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, quantity:) - end + def self.new(effective_date:, quantity:); end sig { override.returns({effective_date: Time, quantity: Integer}) } - def to_hash - end + def to_hash; end end # The updated start date of this price interval. If not specified, the start date @@ -12939,8 +12592,7 @@ module Orb extend Orb::Internal::Type::Union sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } - def self.variants - end + def self.variants; end end end @@ -12970,8 +12622,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment_interval_id:, end_date: nil, start_date: nil) - end + def self.new(adjustment_interval_id:, end_date: nil, start_date: nil); end sig do override @@ -12983,8 +12634,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The updated end date of this adjustment interval. If not specified, the start # date will not be updated. @@ -12992,8 +12642,7 @@ module Orb extend Orb::Internal::Type::Union sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } - def self.variants - end + def self.variants; end end # The updated start date of this adjustment interval. If not specified, the start @@ -13002,8 +12651,7 @@ module Orb extend Orb::Internal::Type::Union sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) } - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/subscription_price_intervals_response.rbi b/rbi/lib/orb/models/subscription_price_intervals_response.rbi index 0231e196..08402acd 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_response.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_response.rbi @@ -91,11 +91,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -193,12 +193,12 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[T.any(Orb::Models::SubscriptionPriceIntervalsResponse::FixedFeeQuantitySchedule, Orb::Internal::AnyHash)], @@ -242,9 +242,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -261,11 +259,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionPriceIntervalsResponse::FixedFeeQuantitySchedule], @@ -283,8 +281,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -332,8 +329,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -353,8 +349,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -408,9 +403,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -425,8 +418,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -478,9 +470,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -495,8 +485,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -548,9 +537,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -565,8 +552,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -624,9 +610,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -642,8 +626,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -695,9 +678,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -712,8 +693,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -722,8 +702,7 @@ module Orb [Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -749,12 +728,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -802,9 +779,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -818,8 +793,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -865,9 +839,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -881,8 +853,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -928,9 +899,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -944,8 +913,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -954,8 +922,7 @@ module Orb [Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionPriceIntervalsResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -975,14 +942,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1038,8 +1003,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1095,8 +1059,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1208,10 +1171,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1261,9 +1224,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1312,8 +1273,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1326,12 +1286,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1348,12 +1306,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1368,8 +1324,7 @@ module Orb UPCOMING = T.let(:upcoming, Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1377,12 +1332,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi b/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi index 7d40eed9..9421e0aa 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi @@ -230,9 +230,7 @@ module Orb trial_duration_days: nil, usage_customer_ids: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -267,8 +265,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module ChangeOption extend Orb::Internal::Type::Enum @@ -289,8 +286,7 @@ module Orb T.let(:immediate, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption::TaggedSymbol]) } - def self.values - end + def self.values; end end class AddAdjustment < Orb::Internal::Type::BaseModel @@ -339,8 +335,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil) - end + def self.new(adjustment:, end_date: nil, plan_phase_order: nil, start_date: nil); end sig do override @@ -359,8 +354,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The definition of a new adjustment to create and add to the subscription. module Adjustment @@ -413,8 +407,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -464,8 +457,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -515,8 +507,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMinimum < Orb::Internal::Type::BaseModel @@ -573,8 +564,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMaximum < Orb::Internal::Type::BaseModel @@ -624,8 +614,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -634,8 +623,7 @@ module Orb [Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment::Adjustment::NewMaximum] ) end - def self.variants - end + def self.variants; end end end @@ -794,9 +782,7 @@ module Orb price: nil, price_id: nil, start_date: nil - ) - end - + ); end sig do override .returns( @@ -842,8 +828,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AllocationPrice < Orb::Internal::Type::BaseModel # An amount of the currency to allocate to the customer at the specified cadence. @@ -874,8 +859,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:) - end + def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end sig do override @@ -888,8 +872,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence at which to allocate the amount to the customer. module Cadence @@ -943,8 +926,7 @@ module Orb T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -989,8 +971,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -1028,8 +1009,7 @@ module Orb T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount::DiscountType::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -1217,9 +1197,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit - ) - end - + ); end sig do override .returns( @@ -1247,8 +1225,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -1302,12 +1279,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class UnitConfig < Orb::Internal::Type::BaseModel @@ -1316,12 +1292,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:) - end + def self.new(unit_amount:); end sig { override.returns({unit_amount: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -1346,8 +1320,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1358,8 +1331,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1393,12 +1365,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1424,8 +1395,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1436,8 +1406,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1471,12 +1440,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -1661,9 +1629,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :package - ) - end - + ); end sig do override .returns( @@ -1691,8 +1657,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -1746,12 +1711,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class PackageConfig < Orb::Internal::Type::BaseModel @@ -1765,12 +1729,10 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:) - end + def self.new(package_amount:, package_size:); end sig { override.returns({package_amount: String, package_size: Integer}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -1795,8 +1757,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1807,8 +1768,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1842,12 +1802,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -1873,8 +1832,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -1885,8 +1843,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -1920,12 +1877,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -2110,9 +2066,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :matrix - ) - end - + ); end sig do override .returns( @@ -2140,8 +2094,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -2195,12 +2148,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -2216,7 +2168,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] ) end @@ -2227,16 +2179,15 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -2245,13 +2196,12 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -2270,12 +2220,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -2301,8 +2249,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2313,8 +2260,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2348,12 +2294,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -2379,8 +2324,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2391,8 +2335,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2426,12 +2369,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -2616,9 +2558,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered - ) - end - + ); end sig do override .returns( @@ -2646,8 +2586,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -2701,12 +2640,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class TieredConfig < Orb::Internal::Type::BaseModel @@ -2714,7 +2652,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier ] ) end @@ -2723,29 +2661,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Inclusive tier starting value @@ -2767,14 +2703,12 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil) - end + def self.new(first_unit:, unit_amount:, last_unit: nil); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end - def to_hash - end + def to_hash; end end end @@ -2800,8 +2734,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2812,8 +2745,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2847,12 +2779,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -2878,8 +2809,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -2890,8 +2820,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -2925,12 +2854,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3115,9 +3043,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_bps - ) - end - + ); end sig do override .returns( @@ -3145,8 +3071,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -3200,12 +3125,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class TieredBpsConfig < Orb::Internal::Type::BaseModel @@ -3214,7 +3138,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] ) end @@ -3223,29 +3147,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Per-event basis point rate @@ -3273,8 +3195,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end sig do override @@ -3287,8 +3208,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -3314,8 +3234,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3326,8 +3245,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3361,12 +3279,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -3392,8 +3309,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3404,8 +3320,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3439,12 +3354,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -3629,9 +3543,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bps - ) - end - + ); end sig do override .returns( @@ -3659,8 +3571,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BpsConfig < Orb::Internal::Type::BaseModel # Basis point take rate per event @@ -3672,12 +3583,10 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil) - end + def self.new(bps:, per_unit_maximum: nil); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } - def to_hash - end + def to_hash; end end # The cadence to bill for this price on. @@ -3732,12 +3641,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -3762,8 +3670,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3774,8 +3681,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3809,12 +3715,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -3840,8 +3745,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -3852,8 +3756,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -3887,12 +3790,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -4077,9 +3979,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk_bps - ) - end - + ); end sig do override .returns( @@ -4107,8 +4007,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -4116,7 +4015,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier ] ) end @@ -4125,29 +4024,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Basis points to rate on @@ -4166,8 +4063,7 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end sig do override.returns( @@ -4178,8 +4074,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -4235,12 +4130,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4265,8 +4159,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4277,8 +4170,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4312,12 +4204,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -4343,8 +4234,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4355,8 +4245,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4390,12 +4279,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -4580,9 +4468,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk - ) - end - + ); end sig do override .returns( @@ -4610,15 +4496,14 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkConfig < Orb::Internal::Type::BaseModel # Bulk tiers for rating based on total usage volume sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier ] ) end @@ -4627,29 +4512,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Amount per unit @@ -4661,12 +4544,10 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil) - end + def self.new(unit_amount:, maximum_units: nil); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -4722,12 +4603,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -4752,8 +4632,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4764,8 +4643,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4799,12 +4677,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -4830,8 +4707,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -4842,8 +4718,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -4877,12 +4752,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5049,9 +4923,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :threshold_total_amount - ) - end - + ); end sig do override .returns( @@ -5079,8 +4951,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5134,12 +5005,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5164,8 +5034,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5176,8 +5045,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5211,12 +5079,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5242,8 +5109,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5254,8 +5120,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5289,12 +5154,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5461,9 +5325,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_package - ) - end - + ); end sig do override .returns( @@ -5491,8 +5353,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5546,12 +5407,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5576,8 +5436,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5588,8 +5447,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5623,12 +5481,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -5654,8 +5511,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -5666,8 +5522,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -5701,12 +5556,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -5873,9 +5727,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_with_minimum - ) - end - + ); end sig do override .returns( @@ -5903,8 +5755,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -5958,12 +5809,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -5988,8 +5838,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6000,8 +5849,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6035,12 +5883,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6066,8 +5913,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6078,8 +5924,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6113,12 +5958,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -6285,9 +6129,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit_with_percent - ) - end - + ); end sig do override .returns( @@ -6315,8 +6157,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -6370,12 +6211,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6400,8 +6240,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6412,8 +6251,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6447,12 +6285,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6478,8 +6315,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6490,8 +6326,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6525,12 +6360,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -6697,9 +6531,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :package_with_allocation - ) - end - + ); end sig do override .returns( @@ -6727,8 +6559,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -6782,12 +6613,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -6812,8 +6642,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6824,8 +6653,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6859,12 +6687,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -6890,8 +6717,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -6902,8 +6728,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -6937,12 +6762,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7109,9 +6933,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_with_proration - ) - end - + ); end sig do override .returns( @@ -7139,8 +6961,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7194,12 +7015,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7224,8 +7044,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7236,8 +7055,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7271,12 +7089,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -7302,8 +7119,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7314,8 +7130,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7349,12 +7164,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7521,9 +7335,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit_with_proration - ) - end - + ); end sig do override .returns( @@ -7551,8 +7363,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -7606,12 +7417,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -7636,8 +7446,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7648,8 +7457,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7683,12 +7491,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -7714,8 +7521,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -7726,8 +7532,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -7761,12 +7566,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -7933,9 +7737,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_allocation - ) - end - + ); end sig do override .returns( @@ -7963,8 +7765,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -8018,12 +7819,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8048,8 +7848,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8060,8 +7859,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8095,12 +7893,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8126,8 +7923,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8138,8 +7934,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8173,12 +7968,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -8345,9 +8139,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_with_prorated_minimum - ) - end - + ); end sig do override .returns( @@ -8375,8 +8167,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -8430,12 +8221,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8460,8 +8250,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8472,8 +8261,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8507,12 +8295,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8538,8 +8325,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8550,8 +8336,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8585,12 +8370,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -8757,9 +8541,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk_with_proration - ) - end - + ); end sig do override .returns( @@ -8787,8 +8569,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -8842,12 +8623,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -8872,8 +8652,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8884,8 +8663,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8919,12 +8697,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -8950,8 +8727,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -8962,8 +8738,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -8997,12 +8772,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9169,9 +8943,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_unit_pricing - ) - end - + ); end sig do override .returns( @@ -9199,8 +8971,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9254,12 +9025,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9284,8 +9054,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9296,8 +9065,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9331,12 +9099,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9362,8 +9129,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9374,8 +9140,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9409,12 +9174,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9581,9 +9345,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing - ) - end - + ); end sig do override .returns( @@ -9611,8 +9373,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -9666,12 +9427,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -9696,8 +9456,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9708,8 +9467,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9743,12 +9501,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -9774,8 +9531,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -9786,8 +9542,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -9821,12 +9576,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -9993,9 +9747,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :cumulative_grouped_bulk - ) - end - + ); end sig do override .returns( @@ -10023,8 +9775,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -10078,12 +9829,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10108,8 +9858,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10120,8 +9869,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10155,12 +9903,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -10186,8 +9933,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10198,8 +9944,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10233,12 +9978,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -10405,9 +10149,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :max_group_tiered_package - ) - end - + ); end sig do override .returns( @@ -10435,8 +10177,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -10490,12 +10231,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10520,8 +10260,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10532,8 +10271,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10567,12 +10305,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -10598,8 +10335,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10610,8 +10346,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10645,12 +10380,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -10817,9 +10551,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_with_metered_minimum - ) - end - + ); end sig do override .returns( @@ -10847,8 +10579,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -10902,12 +10633,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -10932,8 +10662,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -10944,8 +10673,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -10979,12 +10707,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -11010,8 +10737,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11022,8 +10748,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11057,12 +10782,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -11229,9 +10953,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :matrix_with_display_name - ) - end - + ); end sig do override .returns( @@ -11259,8 +10981,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -11314,12 +11035,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11344,8 +11064,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11356,8 +11075,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11391,12 +11109,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -11422,8 +11139,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11434,8 +11150,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11469,12 +11184,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -11641,9 +11355,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_tiered_package - ) - end - + ); end sig do override .returns( @@ -11671,8 +11383,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -11726,12 +11437,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -11756,8 +11466,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11768,8 +11477,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11803,12 +11511,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -11834,8 +11541,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -11846,8 +11552,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -11881,12 +11586,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -11897,8 +11601,7 @@ module Orb [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice] ) end - def self.variants - end + def self.variants; end end end @@ -11936,8 +11639,7 @@ module Orb override .returns(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::TaggedSymbol]) end - def self.values - end + def self.values; end end class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel @@ -11962,12 +11664,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end class RemoveAdjustment < Orb::Internal::Type::BaseModel @@ -11976,12 +11676,10 @@ module Orb attr_accessor :adjustment_id sig { params(adjustment_id: String).returns(T.attached_class) } - def self.new(adjustment_id:) - end + def self.new(adjustment_id:); end sig { override.returns({adjustment_id: String}) } - def to_hash - end + def to_hash; end end class RemovePrice < Orb::Internal::Type::BaseModel @@ -11996,12 +11694,10 @@ module Orb sig do params(external_price_id: T.nilable(String), price_id: T.nilable(String)).returns(T.attached_class) end - def self.new(external_price_id: nil, price_id: nil) - end + def self.new(external_price_id: nil, price_id: nil); end sig { override.returns({external_price_id: T.nilable(String), price_id: T.nilable(String)}) } - def to_hash - end + def to_hash; end end class ReplaceAdjustment < Orb::Internal::Type::BaseModel @@ -12037,8 +11733,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(adjustment:, replaces_adjustment_id:) - end + def self.new(adjustment:, replaces_adjustment_id:); end sig do override @@ -12055,8 +11750,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The definition of a new adjustment to create and add to the subscription. module Adjustment @@ -12109,8 +11803,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewUsageDiscount < Orb::Internal::Type::BaseModel @@ -12160,8 +11853,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewAmountDiscount < Orb::Internal::Type::BaseModel @@ -12211,8 +11903,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMinimum < Orb::Internal::Type::BaseModel @@ -12269,8 +11960,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class NewMaximum < Orb::Internal::Type::BaseModel @@ -12320,8 +12010,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -12330,8 +12019,7 @@ module Orb [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewPercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewUsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewAmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMinimum, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::Adjustment::NewMaximum] ) end - def self.variants - end + def self.variants; end end end @@ -12480,9 +12168,7 @@ module Orb minimum_amount: nil, price: nil, price_id: nil - ) - end - + ); end sig do override .returns( @@ -12527,8 +12213,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AllocationPrice < Orb::Internal::Type::BaseModel # An amount of the currency to allocate to the customer at the specified cadence. @@ -12563,8 +12248,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:) - end + def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end sig do override @@ -12577,8 +12261,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence at which to allocate the amount to the customer. module Cadence @@ -12632,8 +12315,7 @@ module Orb T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::Cadence::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -12678,8 +12360,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -12717,8 +12398,7 @@ module Orb T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount::DiscountType::TaggedSymbol] ) end - def self.values - end + def self.values; end end end @@ -12906,9 +12586,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit - ) - end - + ); end sig do override .returns( @@ -12936,8 +12614,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -12991,12 +12668,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class UnitConfig < Orb::Internal::Type::BaseModel @@ -13005,12 +12681,10 @@ module Orb attr_accessor :unit_amount sig { params(unit_amount: String).returns(T.attached_class) } - def self.new(unit_amount:) - end + def self.new(unit_amount:); end sig { override.returns({unit_amount: String}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -13035,8 +12709,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13047,8 +12720,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -13082,12 +12754,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -13113,8 +12784,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13125,8 +12795,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -13160,12 +12829,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -13350,9 +13018,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :package - ) - end - + ); end sig do override .returns( @@ -13380,8 +13046,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -13435,12 +13100,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class PackageConfig < Orb::Internal::Type::BaseModel @@ -13454,12 +13118,10 @@ module Orb attr_accessor :package_size sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) } - def self.new(package_amount:, package_size:) - end + def self.new(package_amount:, package_size:); end sig { override.returns({package_amount: String, package_size: Integer}) } - def to_hash - end + def to_hash; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -13484,8 +13146,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13496,8 +13157,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -13531,12 +13191,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -13562,8 +13221,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -13574,8 +13232,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -13609,12 +13266,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -13799,9 +13455,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :matrix - ) - end - + ); end sig do override .returns( @@ -13829,8 +13483,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -13884,12 +13537,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class MatrixConfig < Orb::Internal::Type::BaseModel @@ -13905,7 +13557,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] ) end @@ -13916,16 +13568,15 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(default_unit_amount:, dimensions:, matrix_values:) - end + def self.new(default_unit_amount:, dimensions:, matrix_values:); end sig do override @@ -13934,13 +13585,12 @@ module Orb default_unit_amount: String, dimensions: T::Array[T.nilable(String)], matrix_values: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::MatrixConfig::MatrixValue ] } ) end - def to_hash - end + def to_hash; end class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, @@ -13959,12 +13609,10 @@ module Orb unit_amount: String ).returns(T.attached_class) end - def self.new(dimension_values:, unit_amount:) - end + def self.new(dimension_values:, unit_amount:); end sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) } - def to_hash - end + def to_hash; end end end @@ -13990,8 +13638,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14002,8 +13649,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -14037,12 +13683,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -14068,8 +13713,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14080,8 +13724,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -14115,12 +13758,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -14305,9 +13947,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered - ) - end - + ); end sig do override .returns( @@ -14335,8 +13975,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -14390,12 +14029,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class TieredConfig < Orb::Internal::Type::BaseModel @@ -14403,7 +14041,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier ] ) end @@ -14412,29 +14050,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::TieredConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Inclusive tier starting value @@ -14456,14 +14092,12 @@ module Orb last_unit: T.nilable(Float) ).returns(T.attached_class) end - def self.new(first_unit:, unit_amount:, last_unit: nil) - end + def self.new(first_unit:, unit_amount:, last_unit: nil); end sig do override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) end - def to_hash - end + def to_hash; end end end @@ -14489,8 +14123,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14501,8 +14134,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -14536,12 +14168,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -14567,8 +14198,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -14579,8 +14209,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -14614,12 +14243,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -14804,9 +14432,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_bps - ) - end - + ); end sig do override .returns( @@ -14834,8 +14460,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -14889,12 +14514,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class TieredBpsConfig < Orb::Internal::Type::BaseModel @@ -14903,7 +14527,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] ) end @@ -14912,29 +14536,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::TieredBpsConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Per-event basis point rate @@ -14962,8 +14584,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end sig do override @@ -14976,8 +14597,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -15003,8 +14623,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15015,8 +14634,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -15050,12 +14668,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -15081,8 +14698,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15093,8 +14709,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -15128,12 +14743,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -15318,9 +14932,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bps - ) - end - + ); end sig do override .returns( @@ -15348,8 +14960,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BpsConfig < Orb::Internal::Type::BaseModel # Basis point take rate per event @@ -15361,12 +14972,10 @@ module Orb attr_accessor :per_unit_maximum sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) } - def self.new(bps:, per_unit_maximum: nil) - end + def self.new(bps:, per_unit_maximum: nil); end sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) } - def to_hash - end + def to_hash; end end # The cadence to bill for this price on. @@ -15421,12 +15030,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -15451,8 +15059,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15463,8 +15070,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -15498,12 +15104,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -15529,8 +15134,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15541,8 +15145,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -15576,12 +15179,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -15766,9 +15368,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk_bps - ) - end - + ); end sig do override .returns( @@ -15796,8 +15396,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -15805,7 +15404,7 @@ module Orb sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier ] ) end @@ -15814,29 +15413,27 @@ module Orb sig do params( tiers: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Basis points to rate on @@ -15855,8 +15452,7 @@ module Orb params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String)) .returns(T.attached_class) end - def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil) - end + def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end sig do override.returns( @@ -15867,8 +15463,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end @@ -15924,12 +15519,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -15954,8 +15548,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -15966,8 +15559,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16001,12 +15593,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -16032,8 +15623,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -16044,8 +15634,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16079,12 +15668,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -16269,9 +15857,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk - ) - end - + ); end sig do override .returns( @@ -16299,15 +15885,14 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BulkConfig < Orb::Internal::Type::BaseModel # Bulk tiers for rating based on total usage volume sig do returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier ] ) end @@ -16315,30 +15900,28 @@ module Orb sig do params( - tiers: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier, - Orb::Internal::AnyHash - ) + tiers: T::Array[ + T.any( + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier, + Orb::Internal::AnyHash + ) ] ) .returns(T.attached_class) end - def self.new(tiers:) - end + def self.new(tiers:); end sig do override .returns( { tiers: T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BulkConfig::Tier ] } ) end - def to_hash - end + def to_hash; end class Tier < Orb::Internal::Type::BaseModel # Amount per unit @@ -16350,12 +15933,10 @@ module Orb attr_accessor :maximum_units sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) } - def self.new(unit_amount:, maximum_units: nil) - end + def self.new(unit_amount:, maximum_units: nil); end sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) } - def to_hash - end + def to_hash; end end end @@ -16411,12 +15992,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -16441,8 +16021,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -16453,8 +16032,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16488,12 +16066,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -16519,8 +16096,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -16531,8 +16107,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16566,12 +16141,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -16738,9 +16312,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :threshold_total_amount - ) - end - + ); end sig do override .returns( @@ -16768,8 +16340,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -16823,12 +16394,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -16853,8 +16423,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -16865,8 +16434,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16900,12 +16468,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -16931,8 +16498,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -16943,8 +16509,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -16978,12 +16543,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -17150,9 +16714,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_package - ) - end - + ); end sig do override .returns( @@ -17180,8 +16742,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -17235,12 +16796,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -17265,8 +16825,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -17277,8 +16836,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -17312,12 +16870,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -17343,8 +16900,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -17355,8 +16911,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -17390,12 +16945,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -17562,9 +17116,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_with_minimum - ) - end - + ); end sig do override .returns( @@ -17592,8 +17144,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -17647,12 +17198,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -17677,8 +17227,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -17689,8 +17238,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -17724,12 +17272,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -17755,8 +17302,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -17767,8 +17313,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -17802,12 +17347,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -17974,9 +17518,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit_with_percent - ) - end - + ); end sig do override .returns( @@ -18004,8 +17546,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -18059,12 +17600,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -18089,8 +17629,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18101,8 +17640,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18136,12 +17674,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -18167,8 +17704,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18179,8 +17715,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18214,12 +17749,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -18386,9 +17920,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :package_with_allocation - ) - end - + ); end sig do override .returns( @@ -18416,8 +17948,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -18471,12 +18002,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -18501,8 +18031,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18513,8 +18042,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18548,12 +18076,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -18579,8 +18106,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18591,8 +18117,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18626,12 +18151,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -18798,9 +18322,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :tiered_with_proration - ) - end - + ); end sig do override .returns( @@ -18828,8 +18350,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -18883,12 +18404,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -18913,8 +18433,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -18925,8 +18444,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -18960,12 +18478,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -18991,8 +18508,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19003,8 +18519,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -19038,12 +18553,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -19210,9 +18724,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :unit_with_proration - ) - end - + ); end sig do override .returns( @@ -19240,8 +18752,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -19295,12 +18806,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -19325,8 +18835,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19337,8 +18846,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -19372,12 +18880,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -19403,8 +18910,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19415,8 +18921,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -19450,12 +18955,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -19622,9 +19126,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_allocation - ) - end - + ); end sig do override .returns( @@ -19652,8 +19154,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -19707,12 +19208,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -19737,8 +19237,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19749,8 +19248,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -19784,12 +19282,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -19815,8 +19312,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -19827,8 +19323,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -19862,12 +19357,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -20034,9 +19528,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_with_prorated_minimum - ) - end - + ); end sig do override .returns( @@ -20064,8 +19556,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -20119,12 +19610,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -20149,8 +19639,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20161,8 +19650,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20196,12 +19684,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -20227,8 +19714,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20239,8 +19725,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20274,12 +19759,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -20446,9 +19930,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :bulk_with_proration - ) - end - + ); end sig do override .returns( @@ -20476,8 +19958,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -20531,12 +20012,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -20561,8 +20041,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20573,8 +20052,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20608,12 +20086,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -20639,8 +20116,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20651,8 +20127,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -20686,12 +20161,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -20858,9 +20332,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_unit_pricing - ) - end - + ); end sig do override .returns( @@ -20888,8 +20360,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -20943,12 +20414,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -20973,8 +20443,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -20985,8 +20454,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21020,12 +20488,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -21051,8 +20518,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -21063,8 +20529,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21098,12 +20563,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -21270,9 +20734,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :scalable_matrix_with_tiered_pricing - ) - end - + ); end sig do override .returns( @@ -21300,8 +20762,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -21355,12 +20816,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -21385,8 +20845,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -21397,8 +20856,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21432,12 +20890,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -21463,8 +20920,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -21475,8 +20931,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21510,12 +20965,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -21682,9 +21136,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :cumulative_grouped_bulk - ) - end - + ); end sig do override .returns( @@ -21712,8 +21164,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -21767,12 +21218,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -21797,8 +21247,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -21809,8 +21258,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21844,12 +21292,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -21875,8 +21322,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -21887,8 +21333,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -21922,12 +21367,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -22094,9 +21538,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :max_group_tiered_package - ) - end - + ); end sig do override .returns( @@ -22124,8 +21566,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -22179,12 +21620,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -22209,8 +21649,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22221,8 +21660,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22256,12 +21694,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -22287,8 +21724,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22299,8 +21735,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22334,12 +21769,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -22506,9 +21940,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_with_metered_minimum - ) - end - + ); end sig do override .returns( @@ -22536,8 +21968,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -22591,12 +22022,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -22621,8 +22051,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22633,8 +22062,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22668,12 +22096,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -22699,8 +22126,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -22711,8 +22137,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -22746,12 +22171,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -22918,9 +22342,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :matrix_with_display_name - ) - end - + ); end sig do override .returns( @@ -22948,8 +22370,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -23003,12 +22424,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -23033,8 +22453,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -23045,8 +22464,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -23080,12 +22498,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -23111,8 +22528,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -23123,8 +22539,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -23158,12 +22573,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -23330,9 +22744,7 @@ module Orb metadata: nil, reference_id: nil, model_type: :grouped_tiered_package - ) - end - + ); end sig do override .returns( @@ -23360,8 +22772,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The cadence to bill for this price on. module Cadence @@ -23415,12 +22826,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol ] ) end - def self.values - end + def self.values; end end class BillingCycleConfiguration < Orb::Internal::Type::BaseModel @@ -23445,8 +22855,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -23457,8 +22866,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -23492,12 +22900,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end @@ -23523,8 +22930,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(duration:, duration_unit:) - end + def self.new(duration:, duration_unit:); end sig do override @@ -23535,8 +22941,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The unit of billing period duration. module DurationUnit @@ -23570,12 +22975,11 @@ module Orb override .returns( T::Array[ - Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ] ) end - def self.values - end + def self.values; end end end end @@ -23586,8 +22990,7 @@ module Orb [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi b/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi index 2adfee6c..4e17447f 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi @@ -91,11 +91,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -195,19 +195,19 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule, + Orb::Internal::AnyHash + ) ], invoicing_threshold: T.nilable(String), maximum_intervals: T::Array[T.any(Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval, Orb::Internal::AnyHash)], @@ -251,9 +251,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -270,11 +268,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule], @@ -292,8 +290,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -341,8 +338,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -362,8 +358,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -417,9 +412,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -434,8 +427,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -487,9 +479,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -504,8 +494,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -557,9 +546,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -574,8 +561,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -633,9 +619,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -651,8 +635,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -704,9 +687,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -721,8 +702,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -731,8 +711,7 @@ module Orb [Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -758,12 +737,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -811,9 +788,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -827,8 +802,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -874,9 +848,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -890,8 +862,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -937,9 +908,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -953,8 +922,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -963,8 +931,7 @@ module Orb [Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -984,14 +951,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1047,8 +1012,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1104,8 +1068,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1217,10 +1180,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1270,9 +1233,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1321,8 +1282,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1335,12 +1295,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1357,12 +1315,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1378,8 +1334,7 @@ module Orb UPCOMING = T.let(:upcoming, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1387,12 +1342,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_trigger_phase_params.rbi b/rbi/lib/orb/models/subscription_trigger_phase_params.rbi index cba037db..36d1c9cf 100644 --- a/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +++ b/rbi/lib/orb/models/subscription_trigger_phase_params.rbi @@ -25,8 +25,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {}) - end + def self.new(allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {}); end sig do override @@ -38,8 +37,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi index 3ca1c34e..843ec8bf 100644 --- a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +++ b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi @@ -91,11 +91,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -193,12 +193,12 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[T.any(Orb::Models::SubscriptionTriggerPhaseResponse::FixedFeeQuantitySchedule, Orb::Internal::AnyHash)], @@ -242,9 +242,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -261,11 +259,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionTriggerPhaseResponse::FixedFeeQuantitySchedule], @@ -283,8 +281,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -332,8 +329,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -353,8 +349,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -408,9 +403,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -425,8 +418,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -478,9 +470,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -495,8 +485,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -548,9 +537,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -565,8 +552,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -624,9 +610,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -642,8 +626,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -695,9 +678,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -712,8 +693,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -722,8 +702,7 @@ module Orb [Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -749,12 +728,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -802,9 +779,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -818,8 +793,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -865,9 +839,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -881,8 +853,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -928,9 +899,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -944,8 +913,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -954,8 +922,7 @@ module Orb [Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -975,14 +942,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1038,8 +1003,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1095,8 +1059,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1208,10 +1171,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1261,9 +1224,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1312,8 +1273,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1326,12 +1286,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1348,12 +1306,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1368,8 +1324,7 @@ module Orb UPCOMING = T.let(:upcoming, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1377,12 +1332,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi b/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi index 802be2f1..d1e3a5ed 100644 --- a/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi index 091f003b..88c20195 100644 --- a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi @@ -91,11 +91,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -195,19 +195,19 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleCancellationResponse::FixedFeeQuantitySchedule, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnscheduleCancellationResponse::FixedFeeQuantitySchedule, + Orb::Internal::AnyHash + ) ], invoicing_threshold: T.nilable(String), maximum_intervals: T::Array[T.any(Orb::Models::SubscriptionUnscheduleCancellationResponse::MaximumInterval, Orb::Internal::AnyHash)], @@ -251,9 +251,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -270,11 +268,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::FixedFeeQuantitySchedule], @@ -292,8 +290,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -341,8 +338,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -362,8 +358,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -417,9 +412,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -434,8 +427,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -487,9 +479,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -504,8 +494,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -557,9 +546,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -574,8 +561,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -633,9 +619,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -651,8 +635,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -704,9 +687,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -721,8 +702,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -731,8 +711,7 @@ module Orb [Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -758,12 +737,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -811,9 +788,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -827,8 +802,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -874,9 +848,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -890,8 +862,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -937,9 +908,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -953,8 +922,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -963,8 +931,7 @@ module Orb [Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -984,14 +951,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1047,8 +1012,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1104,8 +1068,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1217,10 +1180,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1270,9 +1233,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1321,8 +1282,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1335,12 +1295,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1357,12 +1315,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1379,8 +1335,7 @@ module Orb T.let(:upcoming, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1388,12 +1343,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi index 3e156337..782a87db 100644 --- a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi @@ -14,12 +14,10 @@ module Orb params(price_id: String, request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) .returns(T.attached_class) end - def self.new(price_id:, request_options: {}) - end + def self.new(price_id:, request_options: {}); end sig { override.returns({price_id: String, request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi index c7772d2f..871f03f2 100644 --- a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi @@ -95,11 +95,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -197,10 +197,10 @@ module Orb id: String, active_plan_phase_order: T.nilable(Integer), adjustment_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval, + Orb::Internal::AnyHash + ) ], auto_collection: T.nilable(T::Boolean), billing_cycle_anchor_configuration: T.any( @@ -214,41 +214,41 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::FixedFeeQuantitySchedule, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::FixedFeeQuantitySchedule, + Orb::Internal::AnyHash + ) ], invoicing_threshold: T.nilable(String), maximum_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval, + Orb::Internal::AnyHash + ) ], metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval, + Orb::Internal::AnyHash + ) ], net_terms: Integer, plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval, + Orb::Internal::AnyHash + ) ], redeemed_coupon: T.nilable( T.any( @@ -291,9 +291,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -310,11 +308,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::FixedFeeQuantitySchedule], @@ -332,8 +330,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -381,8 +378,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -402,8 +398,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -457,9 +452,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -474,8 +467,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -527,9 +519,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -544,8 +534,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -597,9 +586,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -614,8 +601,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -673,9 +659,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -691,8 +675,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -744,9 +727,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -761,8 +742,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -771,8 +751,7 @@ module Orb [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -798,12 +777,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -851,9 +828,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -867,8 +842,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -914,9 +888,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -930,8 +902,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -977,9 +948,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -993,8 +962,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -1003,8 +971,7 @@ module Orb [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -1024,14 +991,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1087,8 +1052,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1144,8 +1108,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1183,7 +1146,7 @@ module Orb returns( T.nilable( T::Array[ - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition ] ) ) @@ -1259,10 +1222,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1312,9 +1275,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1327,7 +1288,7 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition ] ), price: T.any( @@ -1365,8 +1326,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1379,12 +1339,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1401,12 +1359,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1436,8 +1392,7 @@ module Orb T::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status::TaggedSymbol] ) end - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1445,12 +1400,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi index 6058550d..8dad61de 100644 --- a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi index ad9ee061..70e2dc80 100644 --- a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi @@ -91,11 +91,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -186,10 +186,10 @@ module Orb id: String, active_plan_phase_order: T.nilable(Integer), adjustment_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval, + Orb::Internal::AnyHash + ) ], auto_collection: T.nilable(T::Boolean), billing_cycle_anchor_configuration: T.any( @@ -203,41 +203,41 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[ - T.any( - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::FixedFeeQuantitySchedule, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::FixedFeeQuantitySchedule, + Orb::Internal::AnyHash + ) ], invoicing_threshold: T.nilable(String), maximum_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MaximumInterval, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MaximumInterval, + Orb::Internal::AnyHash + ) ], metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval, + Orb::Internal::AnyHash + ) ], net_terms: Integer, plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval, + Orb::Internal::AnyHash + ) ], redeemed_coupon: T.nilable( T.any( @@ -277,9 +277,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -296,11 +294,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::FixedFeeQuantitySchedule], @@ -318,8 +316,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -367,8 +364,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -388,8 +384,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -443,9 +438,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -460,8 +453,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -513,9 +505,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -530,8 +520,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -583,9 +572,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -600,8 +587,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -659,9 +645,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -677,8 +661,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -730,9 +713,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -747,8 +728,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -757,8 +737,7 @@ module Orb [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -784,12 +763,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -837,9 +814,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -853,8 +828,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -900,9 +874,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -916,8 +888,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -963,9 +934,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -979,8 +948,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -989,8 +957,7 @@ module Orb [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -1010,14 +977,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1073,8 +1038,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1130,8 +1094,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1243,10 +1206,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1296,9 +1259,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1347,8 +1308,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1361,12 +1321,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1383,12 +1341,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1410,8 +1366,7 @@ module Orb override .returns(T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol]) end - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1419,12 +1374,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi index 8fb0b00c..d013dba3 100644 --- a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +++ b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi @@ -52,9 +52,7 @@ module Orb change_option: nil, effective_date: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -68,8 +66,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # Determines when the change takes effect. Note that if `effective_date` is # specified, this defaults to `effective_date`. Otherwise, this defaults to @@ -96,8 +93,7 @@ module Orb override .returns(T::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption::TaggedSymbol]) end - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi index b0d22c57..6d79aed3 100644 --- a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +++ b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi @@ -91,11 +91,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -195,19 +195,19 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[ - T.any( - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::FixedFeeQuantitySchedule, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::FixedFeeQuantitySchedule, + Orb::Internal::AnyHash + ) ], invoicing_threshold: T.nilable(String), maximum_intervals: T::Array[T.any(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MaximumInterval, Orb::Internal::AnyHash)], @@ -251,9 +251,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -270,11 +268,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::FixedFeeQuantitySchedule], @@ -292,8 +290,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -341,8 +338,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -362,8 +358,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -417,9 +412,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -434,8 +427,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -487,9 +479,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -504,8 +494,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -557,9 +546,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -574,8 +561,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -633,9 +619,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -651,8 +635,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -704,9 +687,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -721,8 +702,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -731,8 +711,7 @@ module Orb [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -758,12 +737,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -811,9 +788,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -827,8 +802,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -874,9 +848,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -890,8 +862,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -937,9 +908,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -953,8 +922,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -963,8 +931,7 @@ module Orb [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -984,14 +951,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1047,8 +1012,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1104,8 +1068,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1217,10 +1180,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1270,9 +1233,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1321,8 +1282,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1335,12 +1295,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1357,12 +1315,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1379,8 +1335,7 @@ module Orb T.let(:upcoming, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1388,12 +1343,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_update_params.rbi b/rbi/lib/orb/models/subscription_update_params.rbi index 3bc579c1..adab0f69 100644 --- a/rbi/lib/orb/models/subscription_update_params.rbi +++ b/rbi/lib/orb/models/subscription_update_params.rbi @@ -54,9 +54,7 @@ module Orb metadata: nil, net_terms: nil, request_options: {} - ) - end - + ); end sig do override .returns( @@ -70,8 +68,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_update_trial_params.rbi b/rbi/lib/orb/models/subscription_update_trial_params.rbi index 3ca7b7ba..87d3faa9 100644 --- a/rbi/lib/orb/models/subscription_update_trial_params.rbi +++ b/rbi/lib/orb/models/subscription_update_trial_params.rbi @@ -27,8 +27,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(trial_end_date:, shift: nil, request_options: {}) - end + def self.new(trial_end_date:, shift: nil, request_options: {}); end sig do override @@ -40,8 +39,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end # The new date that the trial should end, or the literal string `immediate` to end # the trial immediately. @@ -49,8 +47,7 @@ module Orb extend Orb::Internal::Type::Union sig { override.returns([Time, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol]) } - def self.variants - end + def self.variants; end TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate) } OrSymbol = diff --git a/rbi/lib/orb/models/subscription_update_trial_response.rbi b/rbi/lib/orb/models/subscription_update_trial_response.rbi index 61f06079..baa5bcab 100644 --- a/rbi/lib/orb/models/subscription_update_trial_response.rbi +++ b/rbi/lib/orb/models/subscription_update_trial_response.rbi @@ -91,11 +91,11 @@ module Orb sig do returns( T::Array[ - T.any( - Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval + ) ] ) end @@ -191,12 +191,12 @@ module Orb customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, - Orb::Internal::AnyHash, - Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[T.any(Orb::Models::SubscriptionUpdateTrialResponse::FixedFeeQuantitySchedule, Orb::Internal::AnyHash)], @@ -240,9 +240,7 @@ module Orb start_date:, status:, trial_info: - ) - end - + ); end sig do override .returns( @@ -259,11 +257,11 @@ module Orb customer: Orb::Models::Customer, default_invoice_memo: T.nilable(String), discount_intervals: T::Array[ - T.any( - Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, - Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, - Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval - ) + T.any( + Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval + ) ], end_date: T.nilable(Time), fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionUpdateTrialResponse::FixedFeeQuantitySchedule], @@ -281,8 +279,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class AdjustmentInterval < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -330,8 +327,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:) - end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end sig do override @@ -351,8 +347,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module Adjustment extend Orb::Internal::Type::Union @@ -406,9 +401,7 @@ module Orb reason:, usage_discount:, adjustment_type: :usage_discount - ) - end - + ); end sig do override .returns( @@ -423,8 +416,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -476,9 +468,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :amount_discount - ) - end - + ); end sig do override .returns( @@ -493,8 +483,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel @@ -546,9 +535,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :percentage_discount - ) - end - + ); end sig do override .returns( @@ -563,8 +550,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel @@ -622,9 +608,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :minimum - ) - end - + ); end sig do override .returns( @@ -640,8 +624,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel @@ -693,9 +676,7 @@ module Orb plan_phase_order:, reason:, adjustment_type: :maximum - ) - end - + ); end sig do override .returns( @@ -710,8 +691,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -720,8 +700,7 @@ module Orb [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] ) end - def self.variants - end + def self.variants; end end end @@ -747,12 +726,10 @@ module Orb sig do params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class) end - def self.new(day:, month: nil, year: nil) - end + def self.new(day:, month: nil, year: nil); end sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } - def to_hash - end + def to_hash; end end module DiscountInterval @@ -800,9 +777,7 @@ module Orb end_date:, start_date:, discount_type: :amount - ) - end - + ); end sig do override .returns( @@ -816,8 +791,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PercentageDiscountInterval < Orb::Internal::Type::BaseModel @@ -863,9 +837,7 @@ module Orb percentage_discount:, start_date:, discount_type: :percentage - ) - end - + ); end sig do override .returns( @@ -879,8 +851,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class UsageDiscountInterval < Orb::Internal::Type::BaseModel @@ -926,9 +897,7 @@ module Orb start_date:, usage_discount:, discount_type: :usage - ) - end - + ); end sig do override .returns( @@ -942,8 +911,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end sig do @@ -952,8 +920,7 @@ module Orb [Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval] ) end - def self.variants - end + def self.variants; end end class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel @@ -973,14 +940,12 @@ module Orb params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) .returns(T.attached_class) end - def self.new(end_date:, price_id:, quantity:, start_date:) - end + def self.new(end_date:, price_id:, quantity:, start_date:); end sig do override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) end - def to_hash - end + def to_hash; end end class MaximumInterval < Orb::Internal::Type::BaseModel @@ -1036,8 +1001,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class MinimumInterval < Orb::Internal::Type::BaseModel @@ -1093,8 +1057,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end end class PriceInterval < Orb::Internal::Type::BaseModel @@ -1206,10 +1169,10 @@ module Orb filter: T.nilable(String), fixed_fee_quantity_transitions: T.nilable( T::Array[ - T.any( - Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval::FixedFeeQuantityTransition, - Orb::Internal::AnyHash - ) + T.any( + Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) ] ), price: T.any( @@ -1259,9 +1222,7 @@ module Orb price:, start_date:, usage_customer_ids: - ) - end - + ); end sig do override .returns( @@ -1310,8 +1271,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel sig { returns(Time) } @@ -1324,12 +1284,10 @@ module Orb attr_accessor :quantity sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) } - def self.new(effective_date:, price_id:, quantity:) - end + def self.new(effective_date:, price_id:, quantity:); end sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } - def to_hash - end + def to_hash; end end end @@ -1346,12 +1304,10 @@ module Orb sig do params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) end - def self.new(coupon_id:, end_date:, start_date:) - end + def self.new(coupon_id:, end_date:, start_date:); end sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } - def to_hash - end + def to_hash; end end module Status @@ -1366,8 +1322,7 @@ module Orb UPCOMING = T.let(:upcoming, Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol]) } - def self.values - end + def self.values; end end class TrialInfo < Orb::Internal::Type::BaseModel @@ -1375,12 +1330,10 @@ module Orb attr_accessor :end_date sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } - def self.new(end_date:) - end + def self.new(end_date:); end sig { override.returns({end_date: T.nilable(Time)}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/subscription_usage.rbi b/rbi/lib/orb/models/subscription_usage.rbi index f800a833..7944b3e0 100644 --- a/rbi/lib/orb/models/subscription_usage.rbi +++ b/rbi/lib/orb/models/subscription_usage.rbi @@ -15,12 +15,10 @@ module Orb ) .returns(T.attached_class) end - def self.new(data:) - end + def self.new(data:); end sig { override.returns({data: T::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data]}) } - def to_hash - end + def to_hash; end class Data < Orb::Internal::Type::BaseModel sig { returns(Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric) } @@ -54,8 +52,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(billable_metric:, usage:, view_mode:) - end + def self.new(billable_metric:, usage:, view_mode:); end sig do override @@ -67,8 +64,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -78,12 +74,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class Usage < Orb::Internal::Type::BaseModel @@ -99,12 +93,10 @@ module Orb sig do params(quantity: Float, timeframe_end: Time, timeframe_start: Time).returns(T.attached_class) end - def self.new(quantity:, timeframe_end:, timeframe_start:) - end + def self.new(quantity:, timeframe_end:, timeframe_start:); end sig { override.returns({quantity: Float, timeframe_end: Time, timeframe_start: Time}) } - def to_hash - end + def to_hash; end end module ViewMode @@ -135,8 +127,7 @@ module Orb T::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol] ) end - def self.values - end + def self.values; end end end end @@ -148,7 +139,9 @@ module Orb sig { returns(T.nilable(Orb::Models::PaginationMetadata)) } attr_reader :pagination_metadata - sig { params(pagination_metadata: T.nilable(T.any(Orb::Models::PaginationMetadata, Orb::Internal::AnyHash))).void } + sig do + params(pagination_metadata: T.nilable(T.any(Orb::Models::PaginationMetadata, Orb::Internal::AnyHash))).void + end attr_writer :pagination_metadata sig do @@ -158,8 +151,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(data:, pagination_metadata: nil) - end + def self.new(data:, pagination_metadata: nil); end sig do override @@ -170,8 +162,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class Data < Orb::Internal::Type::BaseModel sig { returns(Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric) } @@ -217,8 +208,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(billable_metric:, metric_group:, usage:, view_mode:) - end + def self.new(billable_metric:, metric_group:, usage:, view_mode:); end sig do override @@ -231,8 +221,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end class BillableMetric < Orb::Internal::Type::BaseModel sig { returns(String) } @@ -242,12 +231,10 @@ module Orb attr_accessor :name sig { params(id: String, name: String).returns(T.attached_class) } - def self.new(id:, name:) - end + def self.new(id:, name:); end sig { override.returns({id: String, name: String}) } - def to_hash - end + def to_hash; end end class MetricGroup < Orb::Internal::Type::BaseModel @@ -258,12 +245,10 @@ module Orb attr_accessor :property_value sig { params(property_key: String, property_value: String).returns(T.attached_class) } - def self.new(property_key:, property_value:) - end + def self.new(property_key:, property_value:); end sig { override.returns({property_key: String, property_value: String}) } - def to_hash - end + def to_hash; end end class Usage < Orb::Internal::Type::BaseModel @@ -279,12 +264,10 @@ module Orb sig do params(quantity: Float, timeframe_end: Time, timeframe_start: Time).returns(T.attached_class) end - def self.new(quantity:, timeframe_end:, timeframe_start:) - end + def self.new(quantity:, timeframe_end:, timeframe_start:); end sig { override.returns({quantity: Float, timeframe_end: Time, timeframe_start: Time}) } - def to_hash - end + def to_hash; end end module ViewMode @@ -310,8 +293,7 @@ module Orb override .returns(T::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol]) end - def self.values - end + def self.values; end end end end @@ -322,8 +304,7 @@ module Orb [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage] ) end - def self.variants - end + def self.variants; end end end end diff --git a/rbi/lib/orb/models/subscriptions.rbi b/rbi/lib/orb/models/subscriptions.rbi index 5f3dc671..44a25510 100644 --- a/rbi/lib/orb/models/subscriptions.rbi +++ b/rbi/lib/orb/models/subscriptions.rbi @@ -19,15 +19,13 @@ module Orb ) .returns(T.attached_class) end - def self.new(data:, pagination_metadata:) - end + def self.new(data:, pagination_metadata:); end sig do override .returns({data: T::Array[Orb::Models::Subscription], pagination_metadata: Orb::Models::PaginationMetadata}) end - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/top_level_ping_params.rbi b/rbi/lib/orb/models/top_level_ping_params.rbi index 1e467a3c..fd4b6a65 100644 --- a/rbi/lib/orb/models/top_level_ping_params.rbi +++ b/rbi/lib/orb/models/top_level_ping_params.rbi @@ -9,12 +9,10 @@ module Orb sig do params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) end - def self.new(request_options: {}) - end + def self.new(request_options: {}); end sig { override.returns({request_options: Orb::RequestOptions}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/top_level_ping_response.rbi b/rbi/lib/orb/models/top_level_ping_response.rbi index f62e338f..cc9faccb 100644 --- a/rbi/lib/orb/models/top_level_ping_response.rbi +++ b/rbi/lib/orb/models/top_level_ping_response.rbi @@ -7,12 +7,10 @@ module Orb attr_accessor :response sig { params(response: String).returns(T.attached_class) } - def self.new(response:) - end + def self.new(response:); end sig { override.returns({response: String}) } - def to_hash - end + def to_hash; end end end end diff --git a/rbi/lib/orb/models/trial_discount.rbi b/rbi/lib/orb/models/trial_discount.rbi index 2b836064..62417f4c 100644 --- a/rbi/lib/orb/models/trial_discount.rbi +++ b/rbi/lib/orb/models/trial_discount.rbi @@ -38,9 +38,7 @@ module Orb reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil - ) - end - + ); end sig do override .returns( @@ -53,8 +51,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -65,8 +62,7 @@ module Orb TRIAL = T.let(:trial, Orb::Models::TrialDiscount::DiscountType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::TrialDiscount::DiscountType::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/models/usage_discount.rbi b/rbi/lib/orb/models/usage_discount.rbi index 91eaeb3f..a2388aec 100644 --- a/rbi/lib/orb/models/usage_discount.rbi +++ b/rbi/lib/orb/models/usage_discount.rbi @@ -28,8 +28,7 @@ module Orb ) .returns(T.attached_class) end - def self.new(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil) - end + def self.new(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil); end sig do override @@ -42,8 +41,7 @@ module Orb } ) end - def to_hash - end + def to_hash; end module DiscountType extend Orb::Internal::Type::Enum @@ -54,8 +52,7 @@ module Orb USAGE = T.let(:usage, Orb::Models::UsageDiscount::DiscountType::TaggedSymbol) sig { override.returns(T::Array[Orb::Models::UsageDiscount::DiscountType::TaggedSymbol]) } - def self.values - end + def self.values; end end end end diff --git a/rbi/lib/orb/request_options.rbi b/rbi/lib/orb/request_options.rbi index 846d1886..78c81d0e 100644 --- a/rbi/lib/orb/request_options.rbi +++ b/rbi/lib/orb/request_options.rbi @@ -9,8 +9,7 @@ module Orb class RequestOptions < Orb::Internal::Type::BaseModel # @api private sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void } - def self.validate!(opts) - end + def self.validate!(opts); end # Idempotency key to send with request and all associated retries. Will only be # sent for write requests. @@ -42,7 +41,6 @@ module Orb # Returns a new instance of RequestOptions. sig { params(values: Orb::Internal::AnyHash).returns(T.attached_class) } - def self.new(values = {}) - end + def self.new(values = {}); end end end diff --git a/rbi/lib/orb/resources/alerts.rbi b/rbi/lib/orb/resources/alerts.rbi index 95a40229..9b8abe16 100644 --- a/rbi/lib/orb/resources/alerts.rbi +++ b/rbi/lib/orb/resources/alerts.rbi @@ -11,8 +11,7 @@ module Orb ) .returns(Orb::Models::Alert) end - def retrieve(alert_id, request_options: {}) - end + def retrieve(alert_id, request_options: {}); end # This endpoint updates the thresholds of an alert. sig do @@ -28,9 +27,7 @@ module Orb # The thresholds that define the values at which the alert will be triggered. thresholds:, request_options: {} - ) - end - + ); end # This endpoint returns a list of alerts within Orb. # # The request must specify one of `customer_id`, `external_customer_id`, or @@ -74,9 +71,7 @@ module Orb # Fetch alerts scoped to this subscription_id subscription_id: nil, request_options: {} - ) - end - + ); end # This endpoint creates a new alert to monitor a customer's credit balance. There # are three types of alerts that can be scoped to customers: # `credit_balance_depleted`, `credit_balance_dropped`, and @@ -104,9 +99,7 @@ module Orb # The thresholds that define the values at which the alert will be triggered. thresholds: nil, request_options: {} - ) - end - + ); end # This endpoint creates a new alert to monitor a customer's credit balance. There # are three types of alerts that can be scoped to customers: # `credit_balance_depleted`, `credit_balance_dropped`, and @@ -136,9 +129,7 @@ module Orb # The thresholds that define the values at which the alert will be triggered. thresholds: nil, request_options: {} - ) - end - + ); end # This endpoint is used to create alerts at the subscription level. # # Subscription level alerts can be one of two types: `usage_exceeded` or @@ -169,9 +160,7 @@ module Orb # The metric to track usage for. metric_id: nil, request_options: {} - ) - end - + ); end # This endpoint allows you to disable an alert. To disable a plan-level alert for # a specific subscription, you must include the `subscription_id`. The # `subscription_id` is not required for customer or subscription level alerts. @@ -188,9 +177,7 @@ module Orb # Used to update the status of a plan alert scoped to this subscription_id subscription_id: nil, request_options: {} - ) - end - + ); end # This endpoint allows you to enable an alert. To enable a plan-level alert for a # specific subscription, you must include the `subscription_id`. The # `subscription_id` is not required for customer or subscription level alerts. @@ -207,13 +194,10 @@ module Orb # Used to update the status of a plan alert scoped to this subscription_id subscription_id: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/coupons.rbi b/rbi/lib/orb/resources/coupons.rbi index d155e98f..b4cde03f 100644 --- a/rbi/lib/orb/resources/coupons.rbi +++ b/rbi/lib/orb/resources/coupons.rbi @@ -33,9 +33,7 @@ module Orb # exhausted;`null` here means "unlimited". max_redemptions: nil, request_options: {} - ) - end - + ); end # This endpoint returns a list of all coupons for an account in a list format. # # The list of coupons is ordered starting from the most recently created coupon. @@ -64,9 +62,7 @@ module Orb # coupons). show_archived: nil, request_options: {} - ) - end - + ); end # This endpoint allows a coupon to be archived. Archived coupons can no longer be # redeemed, and will be hidden from lists of active coupons. Additionally, once a # coupon is archived, its redemption code can be reused for a different coupon. @@ -77,8 +73,7 @@ module Orb ) .returns(Orb::Models::Coupon) end - def archive(coupon_id, request_options: {}) - end + def archive(coupon_id, request_options: {}); end # This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption # code, use the [List coupons](list-coupons) endpoint with the redemption_code @@ -90,13 +85,11 @@ module Orb ) .returns(Orb::Models::Coupon) end - def fetch(coupon_id, request_options: {}) - end + def fetch(coupon_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/coupons/subscriptions.rbi b/rbi/lib/orb/resources/coupons/subscriptions.rbi index 28a433f7..2e14d9ee 100644 --- a/rbi/lib/orb/resources/coupons/subscriptions.rbi +++ b/rbi/lib/orb/resources/coupons/subscriptions.rbi @@ -25,13 +25,10 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/credit_notes.rbi b/rbi/lib/orb/resources/credit_notes.rbi index 207ba41c..341df12d 100644 --- a/rbi/lib/orb/resources/credit_notes.rbi +++ b/rbi/lib/orb/resources/credit_notes.rbi @@ -21,9 +21,7 @@ module Orb # An optional reason for the credit note. reason: nil, request_options: {} - ) - end - + ); end # Get a paginated list of CreditNotes. Users can also filter by customer_id, # subscription_id, or external_customer_id. The credit notes will be returned in # reverse chronological order by `creation_time`. @@ -50,9 +48,7 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes) # given an identifier. sig do @@ -62,13 +58,11 @@ module Orb ) .returns(Orb::Models::CreditNote) end - def fetch(credit_note_id, request_options: {}) - end + def fetch(credit_note_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/customers.rbi b/rbi/lib/orb/resources/customers.rbi index 676b09d6..dfbd13b6 100644 --- a/rbi/lib/orb/resources/customers.rbi +++ b/rbi/lib/orb/resources/customers.rbi @@ -205,9 +205,7 @@ module Orb # This cannot be changed after customer creation. timezone: nil, request_options: {} - ) - end - + ); end # This endpoint can be used to update the `payment_provider`, # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`, # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and @@ -392,9 +390,7 @@ module Orb # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | tax_id: nil, request_options: {} - ) - end - + ); end # This endpoint returns a list of all customers for an account. The list of # customers is ordered starting from the most recently created customer. This # endpoint follows Orb's @@ -424,9 +420,7 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # This performs a deletion of this customer, its subscriptions, and its invoices, # provided the customer does not have any issued invoices. Customers with issued # invoices cannot be deleted. This operation is irreversible. Note that this is a @@ -449,8 +443,7 @@ module Orb ) .void end - def delete(customer_id, request_options: {}) - end + def delete(customer_id, request_options: {}); end # This endpoint is used to fetch customer details given an identifier. If the # `Customer` is in the process of being deleted, only the properties `id` and @@ -465,8 +458,7 @@ module Orb ) .returns(Orb::Models::Customer) end - def fetch(customer_id, request_options: {}) - end + def fetch(customer_id, request_options: {}); end # This endpoint is used to fetch customer details given an `external_customer_id` # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). @@ -480,8 +472,7 @@ module Orb ) .returns(Orb::Models::Customer) end - def fetch_by_external_id(external_customer_id, request_options: {}) - end + def fetch_by_external_id(external_customer_id, request_options: {}); end # Sync Orb's payment methods for the customer with their gateway. # @@ -496,8 +487,7 @@ module Orb ) .void end - def sync_payment_methods_from_gateway(external_customer_id, request_options: {}) - end + def sync_payment_methods_from_gateway(external_customer_id, request_options: {}); end # Sync Orb's payment methods for the customer with their gateway. # @@ -512,8 +502,7 @@ module Orb ) .void end - def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, request_options: {}) - end + def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, request_options: {}); end # This endpoint is used to update customer details given an `external_customer_id` # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the @@ -702,13 +691,10 @@ module Orb # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | tax_id: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/customers/balance_transactions.rbi b/rbi/lib/orb/resources/customers/balance_transactions.rbi index dc42432c..8a5a0b8b 100644 --- a/rbi/lib/orb/resources/customers/balance_transactions.rbi +++ b/rbi/lib/orb/resources/customers/balance_transactions.rbi @@ -23,9 +23,7 @@ module Orb # An optional description that can be specified around this entry. description: nil, request_options: {} - ) - end - + ); end # ## The customer balance # # The customer balance is an amount in the customer's currency, which Orb @@ -79,13 +77,10 @@ module Orb operation_time_lt: nil, operation_time_lte: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/customers/costs.rbi b/rbi/lib/orb/resources/customers/costs.rbi index 44b01684..7add89ad 100644 --- a/rbi/lib/orb/resources/customers/costs.rbi +++ b/rbi/lib/orb/resources/customers/costs.rbi @@ -146,9 +146,7 @@ module Orb # behavior. view_mode: nil, request_options: {} - ) - end - + ); end # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in # Orb, calculated by applying pricing information to the underlying usage (see the # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) @@ -291,13 +289,10 @@ module Orb # behavior. view_mode: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/customers/credits.rbi b/rbi/lib/orb/resources/customers/credits.rbi index 44f916ae..0e527c72 100644 --- a/rbi/lib/orb/resources/customers/credits.rbi +++ b/rbi/lib/orb/resources/customers/credits.rbi @@ -41,9 +41,7 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # Returns a paginated list of unexpired, non-zero credit blocks for a customer. # # If `include_all_blocks` is set to `true`, all credit blocks (including expired @@ -75,13 +73,10 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/customers/credits/ledger.rbi b/rbi/lib/orb/resources/customers/credits/ledger.rbi index 8fea12ca..5b32f081 100644 --- a/rbi/lib/orb/resources/customers/credits/ledger.rbi +++ b/rbi/lib/orb/resources/customers/credits/ledger.rbi @@ -103,15 +103,15 @@ module Orb ) .returns( Orb::Internal::Page[ - T.any( - Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry, - Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry, - Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry, - Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry, - Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry, - Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry, - Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry - ) + T.any( + Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry, + Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry, + Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry, + Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry, + Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry, + Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry, + Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry + ) ] ) end @@ -132,9 +132,7 @@ module Orb limit: nil, minimum_amount: nil, request_options: {} - ) - end - + ); end # This endpoint allows you to create a new ledger entry for a specified customer's # balance. This can be used to increment balance, deduct credits, and change the # expiry date of existing credits. @@ -315,9 +313,7 @@ module Orb # Can only be specified when `entry_type=void`. The reason for the void. void_reason: nil, request_options: {} - ) - end - + ); end # This endpoint allows you to create a new ledger entry for a specified customer's # balance. This can be used to increment balance, deduct credits, and change the # expiry date of existing credits. @@ -501,9 +497,7 @@ module Orb # Can only be specified when `entry_type=void`. The reason for the void. void_reason: nil, request_options: {} - ) - end - + ); end # The credits ledger provides _auditing_ functionality over Orb's credits system # with a list of actions that have taken place to modify a customer's credit # balance. This [paginated endpoint](/api-reference/pagination) lists these @@ -602,15 +596,15 @@ module Orb ) .returns( Orb::Internal::Page[ - T.any( - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, - Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry - ) + T.any( + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, + Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry + ) ] ) end @@ -631,13 +625,10 @@ module Orb limit: nil, minimum_amount: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/customers/credits/top_ups.rbi b/rbi/lib/orb/resources/customers/credits/top_ups.rbi index a9b19c09..88907fdd 100644 --- a/rbi/lib/orb/resources/customers/credits/top_ups.rbi +++ b/rbi/lib/orb/resources/customers/credits/top_ups.rbi @@ -50,9 +50,7 @@ module Orb # The unit of expires_after. expires_after_unit: nil, request_options: {} - ) - end - + ); end # List top-ups sig do params( @@ -71,9 +69,7 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # This deactivates the top-up and voids any invoices associated with pending # credit blocks purchased through the top-up. sig do @@ -84,8 +80,7 @@ module Orb ) .void end - def delete(top_up_id, customer_id:, request_options: {}) - end + def delete(top_up_id, customer_id:, request_options: {}); end # This endpoint allows you to create a new top-up for a specified customer's # balance. While this top-up is active, the customer's balance will added in @@ -135,9 +130,7 @@ module Orb # The unit of expires_after. expires_after_unit: nil, request_options: {} - ) - end - + ); end # This deactivates the top-up and voids any invoices associated with pending # credit blocks purchased through the top-up. sig do @@ -148,8 +141,7 @@ module Orb ) .void end - def delete_by_external_id(top_up_id, external_customer_id:, request_options: {}) - end + def delete_by_external_id(top_up_id, external_customer_id:, request_options: {}); end # List top-ups by external ID sig do @@ -169,13 +161,10 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/dimensional_price_groups.rbi b/rbi/lib/orb/resources/dimensional_price_groups.rbi index 6a3840c4..e64a1365 100644 --- a/rbi/lib/orb/resources/dimensional_price_groups.rbi +++ b/rbi/lib/orb/resources/dimensional_price_groups.rbi @@ -36,9 +36,7 @@ module Orb # by setting `metadata` to `null`. metadata: nil, request_options: {} - ) - end - + ); end # Fetch dimensional price group sig do params( @@ -47,8 +45,7 @@ module Orb ) .returns(Orb::Models::DimensionalPriceGroup) end - def retrieve(dimensional_price_group_id, request_options: {}) - end + def retrieve(dimensional_price_group_id, request_options: {}); end # List dimensional price groups sig do @@ -66,13 +63,10 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi b/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi index 401468cb..cee17f55 100644 --- a/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +++ b/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi @@ -12,13 +12,11 @@ module Orb ) .returns(Orb::Models::DimensionalPriceGroup) end - def retrieve(external_dimensional_price_group_id, request_options: {}) - end + def retrieve(external_dimensional_price_group_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/events.rbi b/rbi/lib/orb/resources/events.rbi index a983de7b..bbf270c1 100644 --- a/rbi/lib/orb/resources/events.rbi +++ b/rbi/lib/orb/resources/events.rbi @@ -83,9 +83,7 @@ module Orb # customer external_customer_id: nil, request_options: {} - ) - end - + ); end # This endpoint is used to deprecate a single usage event with a given `event_id`. # `event_id` refers to the `idempotency_key` passed in during ingestion. # @@ -133,8 +131,7 @@ module Orb ) .returns(Orb::Models::EventDeprecateResponse) end - def deprecate(event_id, request_options: {}) - end + def deprecate(event_id, request_options: {}); end # Orb's event ingestion model and API is designed around two core principles: # @@ -359,9 +356,7 @@ module Orb # response debug: nil, request_options: {} - ) - end - + ); end # This endpoint returns a filtered set of events for an account in a # [paginated list format](/api-reference/pagination). # @@ -399,13 +394,10 @@ module Orb # specified, the one week ago is used. timeframe_start: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/events/backfills.rbi b/rbi/lib/orb/resources/events/backfills.rbi index 64bb910a..bc8ac6da 100644 --- a/rbi/lib/orb/resources/events/backfills.rbi +++ b/rbi/lib/orb/resources/events/backfills.rbi @@ -81,9 +81,7 @@ module Orb # events. If false, adds the newly ingested events to the existing events. replace_existing_events: nil, request_options: {} - ) - end - + ); end # This endpoint returns a list of all backfills in a list format. # # The list of backfills is ordered starting from the most recently created @@ -106,9 +104,7 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # Closing a backfill makes the updated usage visible in Orb. Upon closing a # backfill, Orb will asynchronously reflect the updated usage in invoice amounts # and usage graphs. Once all of the updates are complete, the backfill's status @@ -120,8 +116,7 @@ module Orb ) .returns(Orb::Models::Events::BackfillCloseResponse) end - def close(backfill_id, request_options: {}) - end + def close(backfill_id, request_options: {}); end # This endpoint is used to fetch a backfill given an identifier. sig do @@ -131,8 +126,7 @@ module Orb ) .returns(Orb::Models::Events::BackfillFetchResponse) end - def fetch(backfill_id, request_options: {}) - end + def fetch(backfill_id, request_options: {}); end # Reverting a backfill undoes all the effects of closing the backfill. If the # backfill is reflected, the status will transition to `pending_revert` while the @@ -148,13 +142,11 @@ module Orb ) .returns(Orb::Models::Events::BackfillRevertResponse) end - def revert(backfill_id, request_options: {}) - end + def revert(backfill_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/events/volume.rbi b/rbi/lib/orb/resources/events/volume.rbi index 49e25fa5..b704e7ba 100644 --- a/rbi/lib/orb/resources/events/volume.rbi +++ b/rbi/lib/orb/resources/events/volume.rbi @@ -44,13 +44,10 @@ module Orb # volumecount for the hour the time falls in. timeframe_end: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/invoice_line_items.rbi b/rbi/lib/orb/resources/invoice_line_items.rbi index dc103201..ea283476 100644 --- a/rbi/lib/orb/resources/invoice_line_items.rbi +++ b/rbi/lib/orb/resources/invoice_line_items.rbi @@ -32,13 +32,10 @@ module Orb # A date string to specify the line item's start date in the customer's timezone. start_date:, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/invoices.rbi b/rbi/lib/orb/resources/invoices.rbi index 331dee52..83c500a1 100644 --- a/rbi/lib/orb/resources/invoices.rbi +++ b/rbi/lib/orb/resources/invoices.rbi @@ -59,9 +59,7 @@ module Orb # the resulting invoice will require manual review to issue. Defaulted to false. will_auto_issue: nil, request_options: {} - ) - end - + ); end # This endpoint allows you to update the `metadata` property on an invoice. If you # pass null for the metadata value, it will clear any existing metadata for that # invoice. @@ -82,9 +80,7 @@ module Orb # by setting `metadata` to `null`. metadata: nil, request_options: {} - ) - end - + ); end # This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an # account in a list format. # @@ -151,9 +147,7 @@ module Orb status: nil, subscription_id: nil, request_options: {} - ) - end - + ); end # This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an # identifier. sig do @@ -163,8 +157,7 @@ module Orb ) .returns(Orb::Models::Invoice) end - def fetch(invoice_id, request_options: {}) - end + def fetch(invoice_id, request_options: {}); end # This endpoint can be used to fetch the upcoming # [invoice](/core-concepts#invoice) for the current billing period given a @@ -176,8 +169,7 @@ module Orb ) .returns(Orb::Models::InvoiceFetchUpcomingResponse) end - def fetch_upcoming(subscription_id:, request_options: {}) - end + def fetch_upcoming(subscription_id:, request_options: {}); end # This endpoint allows an eligible invoice to be issued manually. This is only # possible with invoices where status is `draft`, `will_auto_issue` is false, and @@ -202,9 +194,7 @@ module Orb # present in the provider. synchronous: nil, request_options: {} - ) - end - + ); end # This endpoint allows an invoice's status to be set the `paid` status. This can # only be done to invoices that are in the `issued` status. sig do @@ -226,9 +216,7 @@ module Orb # An optional note to associate with the payment. notes: nil, request_options: {} - ) - end - + ); end # This endpoint collects payment for an invoice using the customer's default # payment method. This action can only be taken on invoices with status "issued". sig do @@ -238,8 +226,7 @@ module Orb ) .returns(Orb::Models::Invoice) end - def pay(invoice_id, request_options: {}) - end + def pay(invoice_id, request_options: {}); end # This endpoint allows an invoice's status to be set the `void` status. This can # only be done to invoices that are in the `issued` status. @@ -259,13 +246,11 @@ module Orb ) .returns(Orb::Models::Invoice) end - def void(invoice_id, request_options: {}) - end + def void(invoice_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/items.rbi b/rbi/lib/orb/resources/items.rbi index 30a81249..4790c2df 100644 --- a/rbi/lib/orb/resources/items.rbi +++ b/rbi/lib/orb/resources/items.rbi @@ -12,9 +12,7 @@ module Orb # The name of the item. name:, request_options: {} - ) - end - + ); end # This endpoint can be used to update properties on the Item. sig do params( @@ -25,8 +23,7 @@ module Orb ) .returns(Orb::Models::Item) end - def update(item_id, external_connections: nil, name: nil, request_options: {}) - end + def update(item_id, external_connections: nil, name: nil, request_options: {}); end # This endpoint returns a list of all Items, ordered in descending order by # creation time. @@ -45,9 +42,7 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # This endpoint returns an item identified by its item_id. sig do params( @@ -56,13 +51,11 @@ module Orb ) .returns(Orb::Models::Item) end - def fetch(item_id, request_options: {}) - end + def fetch(item_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/metrics.rbi b/rbi/lib/orb/resources/metrics.rbi index a96b6ef4..c246f8fb 100644 --- a/rbi/lib/orb/resources/metrics.rbi +++ b/rbi/lib/orb/resources/metrics.rbi @@ -31,9 +31,7 @@ module Orb # by setting `metadata` to `null`. metadata: nil, request_options: {} - ) - end - + ); end # This endpoint allows you to update the `metadata` property on a metric. If you # pass `null` for the metadata value, it will clear any existing metadata for that # invoice. @@ -52,9 +50,7 @@ module Orb # by setting `metadata` to `null`. metadata: nil, request_options: {} - ) - end - + ); end # This endpoint is used to fetch [metric](/core-concepts##metric) details given a # metric identifier. It returns information about the metrics including its name, # description, and item. @@ -81,9 +77,7 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # This endpoint is used to list [metrics](/core-concepts#metric). It returns # information about the metrics including its name, description, and item. sig do @@ -93,13 +87,11 @@ module Orb ) .returns(Orb::Models::BillableMetric) end - def fetch(metric_id, request_options: {}) - end + def fetch(metric_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/plans.rbi b/rbi/lib/orb/resources/plans.rbi index b460107e..67f00804 100644 --- a/rbi/lib/orb/resources/plans.rbi +++ b/rbi/lib/orb/resources/plans.rbi @@ -12,34 +12,34 @@ module Orb currency: String, name: String, prices: T::Array[ - T.any( - Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, - Orb::Internal::AnyHash, - Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, - Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, - Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, - Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, - Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, - Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, - Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, - Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice - ) + T.any( + Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, + Orb::Internal::AnyHash, + Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, + Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, + Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, + Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, + Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, + Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, + Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice + ) ], default_invoice_memo: T.nilable(String), external_plan_id: T.nilable(String), @@ -73,9 +73,7 @@ module Orb # this defaults to active. status: nil, request_options: {} - ) - end - + ); end # This endpoint can be used to update the `external_plan_id`, and `metadata` of an # existing plan. # @@ -100,9 +98,7 @@ module Orb # by setting `metadata` to `null`. metadata: nil, request_options: {} - ) - end - + ); end # This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for # an account in a list format. The list of plans is ordered starting from the most # recently created plan. The response also includes @@ -134,9 +130,7 @@ module Orb # The plan status to filter to ('active', 'archived', or 'draft'). status: nil, request_options: {} - ) - end - + ); end # This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details # given a plan identifier. It returns information about the prices included in the # plan and their configuration, as well as the product that the plan is attached @@ -161,13 +155,11 @@ module Orb ) .returns(Orb::Models::Plan) end - def fetch(plan_id, request_options: {}) - end + def fetch(plan_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/plans/external_plan_id.rbi b/rbi/lib/orb/resources/plans/external_plan_id.rbi index 8c74611d..0d49dd48 100644 --- a/rbi/lib/orb/resources/plans/external_plan_id.rbi +++ b/rbi/lib/orb/resources/plans/external_plan_id.rbi @@ -28,9 +28,7 @@ module Orb # by setting `metadata` to `null`. metadata: nil, request_options: {} - ) - end - + ); end # This endpoint is used to fetch [plan](/core-concepts##plan-and-price) details # given an external_plan_id identifier. It returns information about the prices # included in the plan and their configuration, as well as the product that the @@ -54,13 +52,11 @@ module Orb ) .returns(Orb::Models::Plan) end - def fetch(external_plan_id, request_options: {}) - end + def fetch(external_plan_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/prices.rbi b/rbi/lib/orb/resources/prices.rbi index 15284930..cb2b44ab 100644 --- a/rbi/lib/orb/resources/prices.rbi +++ b/rbi/lib/orb/resources/prices.rbi @@ -159,9 +159,7 @@ module Orb # by setting `metadata` to `null`. metadata: nil, request_options: {} - ) - end - + ); end # This endpoint allows you to update the `metadata` property on a price. If you # pass null for the metadata value, it will clear any existing metadata for that # price. @@ -211,9 +209,7 @@ module Orb # by setting `metadata` to `null`. metadata: nil, request_options: {} - ) - end - + ); end # This endpoint is used to list all add-on prices created using the # [price creation endpoint](/api-reference/price/create-price). sig do @@ -224,36 +220,36 @@ module Orb ) .returns( Orb::Internal::Page[ - T.any( - Orb::Models::Price::UnitPrice, - Orb::Models::Price::PackagePrice, - Orb::Models::Price::MatrixPrice, - Orb::Models::Price::TieredPrice, - Orb::Models::Price::TieredBpsPrice, - Orb::Models::Price::BpsPrice, - Orb::Models::Price::BulkBpsPrice, - Orb::Models::Price::BulkPrice, - Orb::Models::Price::ThresholdTotalAmountPrice, - Orb::Models::Price::TieredPackagePrice, - Orb::Models::Price::GroupedTieredPrice, - Orb::Models::Price::TieredWithMinimumPrice, - Orb::Models::Price::TieredPackageWithMinimumPrice, - Orb::Models::Price::PackageWithAllocationPrice, - Orb::Models::Price::UnitWithPercentPrice, - Orb::Models::Price::MatrixWithAllocationPrice, - Orb::Models::Price::TieredWithProrationPrice, - Orb::Models::Price::UnitWithProrationPrice, - Orb::Models::Price::GroupedAllocationPrice, - Orb::Models::Price::GroupedWithProratedMinimumPrice, - Orb::Models::Price::GroupedWithMeteredMinimumPrice, - Orb::Models::Price::MatrixWithDisplayNamePrice, - Orb::Models::Price::BulkWithProrationPrice, - Orb::Models::Price::GroupedTieredPackagePrice, - Orb::Models::Price::MaxGroupTieredPackagePrice, - Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, - Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, - Orb::Models::Price::CumulativeGroupedBulkPrice - ) + T.any( + Orb::Models::Price::UnitPrice, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ) ] ) end @@ -264,9 +260,7 @@ module Orb # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} - ) - end - + ); end # This endpoint is used to evaluate the output of a price for a given customer and # time range. It enables filtering and grouping the output using # [computed properties](/extensibility/advanced-metrics#computed-properties), @@ -320,9 +314,7 @@ module Orb # to group the underlying billable metric grouping_keys: nil, request_options: {} - ) - end - + ); end # This endpoint returns a price given an identifier. sig do params( @@ -362,13 +354,11 @@ module Orb ) ) end - def fetch(price_id, request_options: {}) - end + def fetch(price_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/prices/external_price_id.rbi b/rbi/lib/orb/resources/prices/external_price_id.rbi index 84e5b541..228184c2 100644 --- a/rbi/lib/orb/resources/prices/external_price_id.rbi +++ b/rbi/lib/orb/resources/prices/external_price_id.rbi @@ -53,9 +53,7 @@ module Orb # by setting `metadata` to `null`. metadata: nil, request_options: {} - ) - end - + ); end # This endpoint returns a price given an external price id. See the # [price creation API](/api-reference/price/create-price) for more information # about external price aliases. @@ -97,13 +95,11 @@ module Orb ) ) end - def fetch(external_price_id, request_options: {}) - end + def fetch(external_price_id, request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/subscriptions.rbi b/rbi/lib/orb/resources/subscriptions.rbi index 36a6653d..e88e0ad0 100644 --- a/rbi/lib/orb/resources/subscriptions.rbi +++ b/rbi/lib/orb/resources/subscriptions.rbi @@ -386,9 +386,7 @@ module Orb # subscription itself, or any of that customer's children. usage_customer_ids: nil, request_options: {} - ) - end - + ); end # This endpoint can be used to update the `metadata`, `net terms`, # `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties # on a subscription. @@ -427,9 +425,7 @@ module Orb # has a month to pay the invoice. net_terms: nil, request_options: {} - ) - end - + ); end # This endpoint returns a list of all subscriptions for an account as a # [paginated](/api-reference/pagination) list, ordered starting from the most # recently created subscription. For a full discussion of the subscription @@ -468,9 +464,7 @@ module Orb limit: nil, status: nil, request_options: {} - ) - end - + ); end # This endpoint can be used to cancel an existing subscription. It returns the # serialized subscription object with an `end_date` parameter that signifies when # the subscription will transition to an ended state. @@ -554,9 +548,7 @@ module Orb # passed if the `cancel_option` is `requested_date`. cancellation_date: nil, request_options: {} - ) - end - + ); end # This endpoint is used to fetch a [Subscription](/core-concepts##subscription) # given an identifier. sig do @@ -566,8 +558,7 @@ module Orb ) .returns(Orb::Models::Subscription) end - def fetch(subscription_id, request_options: {}) - end + def fetch(subscription_id, request_options: {}); end # This endpoint is used to fetch a day-by-day snapshot of a subscription's costs # in Orb, calculated by applying pricing information to the underlying usage (see @@ -604,9 +595,7 @@ module Orb # behavior. view_mode: nil, request_options: {} - ) - end - + ); end # This endpoint returns a [paginated](/api-reference/pagination) list of all plans # associated with a subscription along with their start and end dates. This list # contains the subscription's initial plan along with past and future plan @@ -636,9 +625,7 @@ module Orb start_date_lt: nil, start_date_lte: nil, request_options: {} - ) - end - + ); end # This endpoint is used to fetch a subscription's usage in Orb. Especially when # combined with optional query parameters, this endpoint is a powerful way to # build visualizations on top of Orb's event data and metrics. @@ -879,9 +866,7 @@ module Orb # behavior. view_mode: nil, request_options: {} - ) - end - + ); end # This endpoint is used to add and edit subscription # [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By # making modifications to a subscription’s price intervals, you can @@ -981,9 +966,7 @@ module Orb # A list of adjustments to edit on the subscription. edit_adjustments: nil, request_options: {} - ) - end - + ); end # This endpoint can be used to change an existing subscription's plan. It returns # the serialized updated subscription object. # @@ -1302,9 +1285,7 @@ module Orb # subscription itself, or any of that customer's children. usage_customer_ids: nil, request_options: {} - ) - end - + ); end # Manually trigger a phase, effective the given date (or the current time, if not # specified). sig do @@ -1326,9 +1307,7 @@ module Orb # to today in the customer's timezone. effective_date: nil, request_options: {} - ) - end - + ); end # This endpoint can be used to unschedule any pending cancellations for a # subscription. # @@ -1342,8 +1321,7 @@ module Orb ) .returns(Orb::Models::SubscriptionUnscheduleCancellationResponse) end - def unschedule_cancellation(subscription_id, request_options: {}) - end + def unschedule_cancellation(subscription_id, request_options: {}); end # This endpoint can be used to clear scheduled updates to the quantity for a fixed # fee. @@ -1363,9 +1341,7 @@ module Orb # Price for which the updates should be cleared. Must be a fixed fee. price_id:, request_options: {} - ) - end - + ); end # This endpoint can be used to unschedule any pending plan changes on an existing # subscription. sig do @@ -1375,8 +1351,7 @@ module Orb ) .returns(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse) end - def unschedule_pending_plan_changes(subscription_id, request_options: {}) - end + def unschedule_pending_plan_changes(subscription_id, request_options: {}); end # This endpoint can be used to update the quantity for a fixed fee. # @@ -1422,9 +1397,7 @@ module Orb # effective according to `change_option`. effective_date: nil, request_options: {} - ) - end - + ); end # This endpoint is used to update the trial end date for a subscription. The new # trial end date must be within the time range of the current plan (i.e. the new # trial end date must be on or after the subscription's start date on the current @@ -1461,13 +1434,10 @@ module Orb # durations, but adjusting their absolute dates). shift: nil, request_options: {} - ) - end - + ); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end diff --git a/rbi/lib/orb/resources/top_level.rbi b/rbi/lib/orb/resources/top_level.rbi index 2c149e6d..c644cab6 100644 --- a/rbi/lib/orb/resources/top_level.rbi +++ b/rbi/lib/orb/resources/top_level.rbi @@ -13,13 +13,11 @@ module Orb params(request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))) .returns(Orb::Models::TopLevelPingResponse) end - def ping(request_options: {}) - end + def ping(request_options: {}); end # @api private sig { params(client: Orb::Client).returns(T.attached_class) } - def self.new(client:) - end + def self.new(client:); end end end end From 6211751f1f0c0aac4440d5d4faf76752a5e50acd Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 5 Apr 2025 23:51:46 +0000 Subject: [PATCH 4/8] chore: update yard comment formatting (#234) --- .solargraph.yml | 1 + lib/orb/internal/transport/base_client.rb | 2 +- .../transport/pooled_net_requester.rb | 2 +- lib/orb/internal/type/base_model.rb | 22 +- lib/orb/internal/type/converter.rb | 40 +- lib/orb/internal/type/enum.rb | 16 +- lib/orb/internal/util.rb | 2 +- lib/orb/models/alert.rb | 18 +- .../alert_create_for_customer_params.rb | 6 +- ...ert_create_for_external_customer_params.rb | 6 +- .../alert_create_for_subscription_params.rb | 6 +- lib/orb/models/alert_list_params.rb | 2 +- lib/orb/models/alert_update_params.rb | 6 +- lib/orb/models/amount_discount.rb | 2 +- lib/orb/models/billable_metric.rb | 14 +- lib/orb/models/coupon.rb | 14 +- lib/orb/models/coupon_create_params.rb | 4 +- lib/orb/models/coupon_list_params.rb | 4 +- .../coupons/subscription_list_params.rb | 2 +- lib/orb/models/credit_note.rb | 2 +- lib/orb/models/credit_note_list_params.rb | 2 +- lib/orb/models/customer.rb | 464 ++--- lib/orb/models/customer_create_params.rb | 446 ++-- lib/orb/models/customer_list_params.rb | 2 +- .../customer_update_by_external_id_params.rb | 448 ++-- lib/orb/models/customer_update_params.rb | 448 ++-- .../balance_transaction_create_response.rb | 4 +- .../balance_transaction_list_params.rb | 2 +- .../balance_transaction_list_response.rb | 4 +- .../cost_list_by_external_id_params.rb | 12 +- lib/orb/models/customers/cost_list_params.rb | 12 +- .../credit_list_by_external_id_params.rb | 4 +- .../models/customers/credit_list_params.rb | 4 +- ...dger_create_entry_by_external_id_params.rb | 40 +- ...er_create_entry_by_external_id_response.rb | 44 +- .../credits/ledger_create_entry_params.rb | 40 +- .../credits/ledger_create_entry_response.rb | 44 +- .../ledger_list_by_external_id_params.rb | 2 +- .../ledger_list_by_external_id_response.rb | 44 +- .../customers/credits/ledger_list_params.rb | 2 +- .../customers/credits/ledger_list_response.rb | 44 +- .../top_up_create_by_external_id_params.rb | 16 +- .../top_up_create_by_external_id_response.rb | 14 +- .../customers/credits/top_up_create_params.rb | 16 +- .../credits/top_up_create_response.rb | 14 +- .../top_up_list_by_external_id_params.rb | 2 +- .../top_up_list_by_external_id_response.rb | 14 +- .../customers/credits/top_up_list_params.rb | 2 +- .../customers/credits/top_up_list_response.rb | 14 +- lib/orb/models/dimensional_price_group.rb | 14 +- .../dimensional_price_group_create_params.rb | 4 +- .../dimensional_price_group_list_params.rb | 2 +- lib/orb/models/event_ingest_params.rb | 14 +- lib/orb/models/event_ingest_response.rb | 8 +- lib/orb/models/event_search_params.rb | 10 +- lib/orb/models/event_search_response.rb | 16 +- lib/orb/models/event_update_params.rb | 8 +- .../models/events/backfill_close_response.rb | 14 +- .../models/events/backfill_create_params.rb | 22 +- .../models/events/backfill_create_response.rb | 14 +- .../models/events/backfill_fetch_response.rb | 14 +- lib/orb/models/events/backfill_list_params.rb | 2 +- .../models/events/backfill_list_response.rb | 14 +- .../models/events/backfill_revert_response.rb | 14 +- lib/orb/models/events/event_volumes.rb | 2 +- lib/orb/models/events/volume_list_params.rb | 14 +- lib/orb/models/invoice.rb | 540 ++--- lib/orb/models/invoice_create_params.rb | 20 +- .../models/invoice_fetch_upcoming_response.rb | 532 ++--- lib/orb/models/invoice_issue_params.rb | 8 +- .../models/invoice_line_item_create_params.rb | 2 +- .../invoice_line_item_create_response.rb | 54 +- lib/orb/models/invoice_list_params.rb | 8 +- lib/orb/models/invoice_update_params.rb | 4 +- lib/orb/models/item.rb | 4 +- lib/orb/models/item_list_params.rb | 2 +- lib/orb/models/metric_create_params.rb | 4 +- lib/orb/models/metric_list_params.rb | 2 +- lib/orb/models/metric_update_params.rb | 4 +- lib/orb/models/percentage_discount.rb | 4 +- lib/orb/models/plan.rb | 70 +- lib/orb/models/plan_create_params.rb | 526 ++--- lib/orb/models/plan_list_params.rb | 2 +- lib/orb/models/plan_update_params.rb | 8 +- .../plans/external_plan_id_update_params.rb | 8 +- lib/orb/models/price.rb | 308 +-- lib/orb/models/price_create_params.rb | 32 +- lib/orb/models/price_evaluate_params.rb | 8 +- lib/orb/models/price_list_params.rb | 2 +- lib/orb/models/price_update_params.rb | 4 +- .../prices/external_price_id_update_params.rb | 4 +- lib/orb/models/subscription.rb | 174 +- lib/orb/models/subscription_cancel_params.rb | 6 +- .../models/subscription_cancel_response.rb | 144 +- lib/orb/models/subscription_create_params.rb | 1256 +++++------ .../models/subscription_create_response.rb | 144 +- .../models/subscription_fetch_costs_params.rb | 12 +- .../subscription_fetch_schedule_params.rb | 2 +- .../subscription_fetch_schedule_response.rb | 4 +- .../models/subscription_fetch_usage_params.rb | 16 +- lib/orb/models/subscription_list_params.rb | 2 +- .../subscription_price_intervals_params.rb | 632 +++--- .../subscription_price_intervals_response.rb | 144 +- ...ubscription_schedule_plan_change_params.rb | 1266 ++++++------ ...scription_schedule_plan_change_response.rb | 144 +- .../subscription_trigger_phase_params.rb | 6 +- .../subscription_trigger_phase_response.rb | 144 +- ...iption_unschedule_cancellation_response.rb | 144 +- ...ule_fixed_fee_quantity_updates_response.rb | 144 +- ...nschedule_pending_plan_changes_response.rb | 144 +- ...iption_update_fixed_fee_quantity_params.rb | 16 +- ...tion_update_fixed_fee_quantity_response.rb | 144 +- lib/orb/models/subscription_update_params.rb | 20 +- .../subscription_update_trial_params.rb | 6 +- .../subscription_update_trial_response.rb | 144 +- lib/orb/models/trial_discount.rb | 2 +- lib/orb/models/usage_discount.rb | 4 +- lib/orb/request_options.rb | 14 +- lib/orb/resources/alerts.rb | 68 +- lib/orb/resources/coupons.rb | 18 +- lib/orb/resources/coupons/subscriptions.rb | 6 +- lib/orb/resources/credit_notes.rb | 8 +- lib/orb/resources/customers.rb | 88 +- .../customers/balance_transactions.rb | 44 +- lib/orb/resources/customers/costs.rb | 464 ++--- lib/orb/resources/customers/credits.rb | 16 +- lib/orb/resources/customers/credits/ledger.rb | 672 +++--- .../resources/customers/credits/top_ups.rb | 24 +- lib/orb/resources/dimensional_price_groups.rb | 12 +- lib/orb/resources/events.rb | 590 +++--- lib/orb/resources/events/backfills.rb | 98 +- lib/orb/resources/events/volume.rb | 20 +- lib/orb/resources/invoice_line_items.rb | 2 +- lib/orb/resources/invoices.rb | 60 +- lib/orb/resources/items.rb | 2 +- lib/orb/resources/metrics.rb | 14 +- lib/orb/resources/plans.rb | 36 +- lib/orb/resources/plans/external_plan_id.rb | 28 +- lib/orb/resources/prices.rb | 60 +- lib/orb/resources/prices/external_price_id.rb | 8 +- lib/orb/resources/subscriptions.rb | 1610 +++++++-------- lib/orb/resources/top_level.rb | 8 +- rbi/lib/orb/internal.rbi | 2 +- .../orb/internal/transport/base_client.rbi | 2 +- .../transport/pooled_net_requester.rbi | 2 +- rbi/lib/orb/internal/type/base_model.rbi | 32 +- rbi/lib/orb/internal/type/converter.rbi | 40 +- rbi/lib/orb/internal/type/enum.rbi | 16 +- rbi/lib/orb/internal/util.rbi | 2 +- rbi/lib/orb/models/alert.rbi | 18 +- .../alert_create_for_customer_params.rbi | 6 +- ...rt_create_for_external_customer_params.rbi | 6 +- .../alert_create_for_subscription_params.rbi | 6 +- rbi/lib/orb/models/alert_list_params.rbi | 2 +- rbi/lib/orb/models/alert_update_params.rbi | 6 +- rbi/lib/orb/models/amount_discount.rbi | 2 +- rbi/lib/orb/models/billable_metric.rbi | 14 +- rbi/lib/orb/models/coupon.rbi | 14 +- rbi/lib/orb/models/coupon_create_params.rbi | 4 +- rbi/lib/orb/models/coupon_list_params.rbi | 4 +- .../coupons/subscription_list_params.rbi | 2 +- rbi/lib/orb/models/credit_note.rbi | 2 +- .../orb/models/credit_note_list_params.rbi | 2 +- rbi/lib/orb/models/customer.rbi | 464 ++--- rbi/lib/orb/models/customer_create_params.rbi | 446 ++-- rbi/lib/orb/models/customer_list_params.rbi | 2 +- .../customer_update_by_external_id_params.rbi | 448 ++-- rbi/lib/orb/models/customer_update_params.rbi | 448 ++-- .../balance_transaction_create_response.rbi | 4 +- .../balance_transaction_list_params.rbi | 2 +- .../balance_transaction_list_response.rbi | 4 +- .../cost_list_by_external_id_params.rbi | 12 +- .../orb/models/customers/cost_list_params.rbi | 12 +- .../credit_list_by_external_id_params.rbi | 4 +- .../models/customers/credit_list_params.rbi | 4 +- ...ger_create_entry_by_external_id_params.rbi | 40 +- ...r_create_entry_by_external_id_response.rbi | 44 +- .../credits/ledger_create_entry_params.rbi | 40 +- .../credits/ledger_create_entry_response.rbi | 44 +- .../ledger_list_by_external_id_params.rbi | 2 +- .../ledger_list_by_external_id_response.rbi | 44 +- .../customers/credits/ledger_list_params.rbi | 2 +- .../credits/ledger_list_response.rbi | 44 +- .../top_up_create_by_external_id_params.rbi | 16 +- .../top_up_create_by_external_id_response.rbi | 14 +- .../credits/top_up_create_params.rbi | 16 +- .../credits/top_up_create_response.rbi | 14 +- .../top_up_list_by_external_id_params.rbi | 2 +- .../top_up_list_by_external_id_response.rbi | 14 +- .../customers/credits/top_up_list_params.rbi | 2 +- .../credits/top_up_list_response.rbi | 14 +- .../orb/models/dimensional_price_group.rbi | 14 +- .../dimensional_price_group_create_params.rbi | 4 +- .../dimensional_price_group_list_params.rbi | 2 +- rbi/lib/orb/models/event_ingest_params.rbi | 14 +- rbi/lib/orb/models/event_ingest_response.rbi | 8 +- rbi/lib/orb/models/event_search_params.rbi | 10 +- rbi/lib/orb/models/event_search_response.rbi | 16 +- rbi/lib/orb/models/event_update_params.rbi | 8 +- .../models/events/backfill_close_response.rbi | 14 +- .../models/events/backfill_create_params.rbi | 22 +- .../events/backfill_create_response.rbi | 14 +- .../models/events/backfill_fetch_response.rbi | 14 +- .../models/events/backfill_list_params.rbi | 2 +- .../models/events/backfill_list_response.rbi | 14 +- .../events/backfill_revert_response.rbi | 14 +- rbi/lib/orb/models/events/event_volumes.rbi | 2 +- .../orb/models/events/volume_list_params.rbi | 14 +- rbi/lib/orb/models/invoice.rbi | 540 ++--- rbi/lib/orb/models/invoice_create_params.rbi | 20 +- .../invoice_fetch_upcoming_response.rbi | 532 ++--- rbi/lib/orb/models/invoice_issue_params.rbi | 8 +- .../invoice_line_item_create_params.rbi | 2 +- .../invoice_line_item_create_response.rbi | 54 +- rbi/lib/orb/models/invoice_list_params.rbi | 8 +- rbi/lib/orb/models/invoice_update_params.rbi | 4 +- rbi/lib/orb/models/item.rbi | 4 +- rbi/lib/orb/models/item_list_params.rbi | 2 +- rbi/lib/orb/models/metric_create_params.rbi | 4 +- rbi/lib/orb/models/metric_list_params.rbi | 2 +- rbi/lib/orb/models/metric_update_params.rbi | 4 +- rbi/lib/orb/models/percentage_discount.rbi | 4 +- rbi/lib/orb/models/plan.rbi | 70 +- rbi/lib/orb/models/plan_create_params.rbi | 526 ++--- rbi/lib/orb/models/plan_list_params.rbi | 2 +- rbi/lib/orb/models/plan_update_params.rbi | 8 +- .../plans/external_plan_id_update_params.rbi | 8 +- rbi/lib/orb/models/price.rbi | 308 +-- rbi/lib/orb/models/price_create_params.rbi | 32 +- rbi/lib/orb/models/price_evaluate_params.rbi | 8 +- rbi/lib/orb/models/price_list_params.rbi | 2 +- rbi/lib/orb/models/price_update_params.rbi | 4 +- .../external_price_id_update_params.rbi | 4 +- rbi/lib/orb/models/subscription.rbi | 174 +- .../orb/models/subscription_cancel_params.rbi | 6 +- .../models/subscription_cancel_response.rbi | 144 +- .../orb/models/subscription_create_params.rbi | 1256 +++++------ .../models/subscription_create_response.rbi | 144 +- .../subscription_fetch_costs_params.rbi | 12 +- .../subscription_fetch_schedule_params.rbi | 2 +- .../subscription_fetch_schedule_response.rbi | 4 +- .../subscription_fetch_usage_params.rbi | 16 +- .../orb/models/subscription_list_params.rbi | 2 +- .../subscription_price_intervals_params.rbi | 632 +++--- .../subscription_price_intervals_response.rbi | 144 +- ...bscription_schedule_plan_change_params.rbi | 1266 ++++++------ ...cription_schedule_plan_change_response.rbi | 144 +- .../subscription_trigger_phase_params.rbi | 6 +- .../subscription_trigger_phase_response.rbi | 144 +- ...ption_unschedule_cancellation_response.rbi | 144 +- ...le_fixed_fee_quantity_updates_response.rbi | 144 +- ...schedule_pending_plan_changes_response.rbi | 144 +- ...ption_update_fixed_fee_quantity_params.rbi | 16 +- ...ion_update_fixed_fee_quantity_response.rbi | 144 +- .../orb/models/subscription_update_params.rbi | 20 +- .../subscription_update_trial_params.rbi | 6 +- .../subscription_update_trial_response.rbi | 144 +- rbi/lib/orb/models/trial_discount.rbi | 2 +- rbi/lib/orb/models/usage_discount.rbi | 4 +- rbi/lib/orb/request_options.rbi | 14 +- rbi/lib/orb/resources/alerts.rbi | 70 +- rbi/lib/orb/resources/coupons.rbi | 26 +- .../orb/resources/coupons/subscriptions.rbi | 8 +- rbi/lib/orb/resources/credit_notes.rbi | 10 +- rbi/lib/orb/resources/customers.rbi | 784 +++---- .../customers/balance_transactions.rbi | 46 +- rbi/lib/orb/resources/customers/costs.rbi | 476 ++--- rbi/lib/orb/resources/customers/credits.rbi | 24 +- .../resources/customers/credits/ledger.rbi | 728 +++---- .../resources/customers/credits/top_ups.rbi | 44 +- .../resources/dimensional_price_groups.rbi | 18 +- rbi/lib/orb/resources/events.rbi | 612 +++--- rbi/lib/orb/resources/events/backfills.rbi | 110 +- rbi/lib/orb/resources/events/volume.rbi | 34 +- rbi/lib/orb/resources/invoice_line_items.rbi | 4 +- rbi/lib/orb/resources/invoices.rbi | 100 +- rbi/lib/orb/resources/items.rbi | 4 +- rbi/lib/orb/resources/metrics.rbi | 24 +- rbi/lib/orb/resources/plans.rbi | 60 +- .../orb/resources/plans/external_plan_id.rbi | 36 +- rbi/lib/orb/resources/prices.rbi | 82 +- .../resources/prices/external_price_id.rbi | 12 +- rbi/lib/orb/resources/subscriptions.rbi | 1832 ++++++++--------- rbi/lib/orb/resources/top_level.rbi | 8 +- 284 files changed, 14159 insertions(+), 14158 deletions(-) diff --git a/.solargraph.yml b/.solargraph.yml index 4738eea1..adc3a0a0 100644 --- a/.solargraph.yml +++ b/.solargraph.yml @@ -5,6 +5,7 @@ include: - 'Rakefile' - 'examples/**/*.rb' - 'lib/**/*.rb' + - 'test/orb-billing/resource_namespaces.rb' - 'test/orb-billing/test_helper.rb' exclude: - 'rbi/**/*' diff --git a/lib/orb/internal/transport/base_client.rb b/lib/orb/internal/transport/base_client.rb index 379c7ee7..c2959112 100644 --- a/lib/orb/internal/transport/base_client.rb +++ b/lib/orb/internal/transport/base_client.rb @@ -393,7 +393,7 @@ def initialize( end # Execute the request specified by `req`. This is the method that all resource - # methods call into. + # methods call into. # # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Orb::Internal::Type::Unknown, options: {}) # diff --git a/lib/orb/internal/transport/pooled_net_requester.rb b/lib/orb/internal/transport/pooled_net_requester.rb index a858cc43..3291cd5d 100644 --- a/lib/orb/internal/transport/pooled_net_requester.rb +++ b/lib/orb/internal/transport/pooled_net_requester.rb @@ -6,7 +6,7 @@ module Transport # @api private class PooledNetRequester # from the golang stdlib - # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 + # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 KEEP_ALIVE_TIMEOUT = 30 class << self diff --git a/lib/orb/internal/type/base_model.rb b/lib/orb/internal/type/base_model.rb index b93b0e38..acdf613d 100644 --- a/lib/orb/internal/type/base_model.rb +++ b/lib/orb/internal/type/base_model.rb @@ -19,7 +19,7 @@ class << self # @api private # # Assumes superclass fields are totally defined before fields are accessed / - # defined on subclasses. + # defined on subclasses. # # @return [Hash{Symbol=>Hash{Symbol=>Object}}] def known_fields @@ -143,7 +143,7 @@ def optional(name_sym, type_info, spec = {}) # @api private # # `request_only` attributes not excluded from `.#coerce` when receiving responses - # even if well behaved servers should not send them + # even if well behaved servers should not send them # # @param blk [Proc] private def request_only(&blk) @@ -291,11 +291,11 @@ def dump(value) end # Returns the raw value associated with the given key, if found. Otherwise, nil is - # returned. + # returned. # - # It is valid to lookup keys that are not in the API spec, for example to access - # undocumented features. This method does not parse response data into - # higher-level types. Lookup by anything other than a Symbol is an ArgumentError. + # It is valid to lookup keys that are not in the API spec, for example to access + # undocumented features. This method does not parse response data into + # higher-level types. Lookup by anything other than a Symbol is an ArgumentError. # # @param key [Symbol] # @@ -310,12 +310,12 @@ def [](key) # Returns a Hash of the data underlying this object. O(1) # - # Keys are Symbols and values are the raw values from the response. The return - # value indicates which values were ever set on the object. i.e. there will be a - # key in this hash if they ever were, even if the set value was nil. + # Keys are Symbols and values are the raw values from the response. The return + # value indicates which values were ever set on the object. i.e. there will be a + # key in this hash if they ever were, even if the set value was nil. # - # This method is not recursive. The returned value is shared by the object, so it - # should not be mutated. + # This method is not recursive. The returned value is shared by the object, so it + # should not be mutated. # # @return [Hash{Symbol=>Object}] def to_h = @data diff --git a/lib/orb/internal/type/converter.rb b/lib/orb/internal/type/converter.rb index af5c4084..f3ba827a 100644 --- a/lib/orb/internal/type/converter.rb +++ b/lib/orb/internal/type/converter.rb @@ -75,37 +75,37 @@ def type_info(spec) # # Based on `target`, transform `value` into `target`, to the extent possible: # - # 1. if the given `value` conforms to `target` already, return the given `value` - # 2. if it's possible and safe to convert the given `value` to `target`, then the - # converted value - # 3. otherwise, the given `value` unaltered + # 1. if the given `value` conforms to `target` already, return the given `value` + # 2. if it's possible and safe to convert the given `value` to `target`, then the + # converted value + # 3. otherwise, the given `value` unaltered # - # The coercion process is subject to improvement between minor release versions. - # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode + # The coercion process is subject to improvement between minor release versions. + # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode # # @param target [Orb::Internal::Type::Converter, Class] # # @param value [Object] # # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`, or `:strong`. This informs the - # coercion strategy when we have to decide between multiple possible conversion - # targets: + # coercion strategy when we have to decide between multiple possible conversion + # targets: # - # - `true`: the conversion must be exact, with minimum coercion. - # - `false`: the conversion can be approximate, with some coercion. - # - `:strong`: the conversion must be exact, with no coercion, and raise an error - # if not possible. + # - `true`: the conversion must be exact, with minimum coercion. + # - `false`: the conversion can be approximate, with some coercion. + # - `:strong`: the conversion must be exact, with no coercion, and raise an error + # if not possible. # - # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For - # any given conversion attempt, the exactness will be updated based on how closely - # the value recursively matches the target type: + # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For + # any given conversion attempt, the exactness will be updated based on how closely + # the value recursively matches the target type: # - # - `yes`: the value can be converted to the target type with minimum coercion. - # - `maybe`: the value can be converted to the target type with some reasonable - # coercion. - # - `no`: the value cannot be converted to the target type. + # - `yes`: the value can be converted to the target type with minimum coercion. + # - `maybe`: the value can be converted to the target type with some reasonable + # coercion. + # - `no`: the value cannot be converted to the target type. # - # See implementation below for more details. + # See implementation below for more details. # # @option state [Boolean, :strong] :strictness # diff --git a/lib/orb/internal/type/enum.rb b/lib/orb/internal/type/enum.rb index f674594a..43eac2f8 100644 --- a/lib/orb/internal/type/enum.rb +++ b/lib/orb/internal/type/enum.rb @@ -6,15 +6,15 @@ module Type # @api private # # A value from among a specified list of options. OpenAPI enum values map to Ruby - # values in the SDK as follows: + # values in the SDK as follows: # - # 1. boolean => true | false - # 2. integer => Integer - # 3. float => Float - # 4. string => Symbol + # 1. boolean => true | false + # 2. integer => Integer + # 3. float => Float + # 4. string => Symbol # - # We can therefore convert string values to Symbols, but can't convert other - # values safely. + # We can therefore convert string values to Symbols, but can't convert other + # values safely. # # @example # # `billing_cycle_relative_date` is a `Orb::Models::BillingCycleRelativeDate` @@ -66,7 +66,7 @@ def ==(other) # @api private # # Unlike with primitives, `Enum` additionally validates that the value is a member - # of the enum. + # of the enum. # # @param value [String, Symbol, Object] # diff --git a/lib/orb/internal/util.rb b/lib/orb/internal/util.rb index 23901dbf..75239677 100644 --- a/lib/orb/internal/util.rb +++ b/lib/orb/internal/util.rb @@ -152,7 +152,7 @@ class << self # @api private # # Recursively merge one hash with another. If the values at a given key are not - # both hashes, just take the new value. + # both hashes, just take the new value. # # @param values [Array] # diff --git a/lib/orb/models/alert.rb b/lib/orb/models/alert.rb index df6189b3..95dd44f0 100644 --- a/lib/orb/models/alert.rb +++ b/lib/orb/models/alert.rb @@ -54,7 +54,7 @@ class Alert < Orb::Internal::Type::BaseModel # @!attribute thresholds # The thresholds that define the conditions under which the alert will be - # triggered. + # triggered. # # @return [Array, nil] required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Alert::Threshold] }, nil?: true @@ -67,10 +67,10 @@ class Alert < Orb::Internal::Type::BaseModel # @!parse # # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, - # # usage, or credit balance and trigger webhooks when a threshold is exceeded. + # # usage, or credit balance and trigger webhooks when a threshold is exceeded. # # - # # Alerts created through the API can be scoped to either customers or - # # subscriptions. + # # Alerts created through the API can be scoped to either customers or + # # subscriptions. # # # # @param id [String] # # @param created_at [Time] @@ -136,8 +136,8 @@ class Plan < Orb::Internal::Type::BaseModel # @!attribute external_plan_id # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. # # @return [String, nil] required :external_plan_id, String, nil?: true @@ -185,15 +185,15 @@ class Subscription < Orb::Internal::Type::BaseModel class Threshold < Orb::Internal::Type::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. # # @return [Float] required :value, Float # @!parse # # Thresholds are used to define the conditions under which an alert will be - # # triggered. + # # triggered. # # # # @param value [Float] # # diff --git a/lib/orb/models/alert_create_for_customer_params.rb b/lib/orb/models/alert_create_for_customer_params.rb index 6a76ec63..b3fca12f 100644 --- a/lib/orb/models/alert_create_for_customer_params.rb +++ b/lib/orb/models/alert_create_for_customer_params.rb @@ -56,15 +56,15 @@ module Type class Threshold < Orb::Internal::Type::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. # # @return [Float] required :value, Float # @!parse # # Thresholds are used to define the conditions under which an alert will be - # # triggered. + # # triggered. # # # # @param value [Float] # # 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 55fac1c2..7b167b23 100644 --- a/lib/orb/models/alert_create_for_external_customer_params.rb +++ b/lib/orb/models/alert_create_for_external_customer_params.rb @@ -56,15 +56,15 @@ module Type class Threshold < Orb::Internal::Type::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. # # @return [Float] required :value, Float # @!parse # # Thresholds are used to define the conditions under which an alert will be - # # triggered. + # # triggered. # # # # @param value [Float] # # diff --git a/lib/orb/models/alert_create_for_subscription_params.rb b/lib/orb/models/alert_create_for_subscription_params.rb index b0e8da8e..8e49770c 100644 --- a/lib/orb/models/alert_create_for_subscription_params.rb +++ b/lib/orb/models/alert_create_for_subscription_params.rb @@ -40,15 +40,15 @@ class AlertCreateForSubscriptionParams < Orb::Internal::Type::BaseModel class Threshold < Orb::Internal::Type::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. # # @return [Float] required :value, Float # @!parse # # Thresholds are used to define the conditions under which an alert will be - # # triggered. + # # triggered. # # # # @param value [Float] # # diff --git a/lib/orb/models/alert_list_params.rb b/lib/orb/models/alert_list_params.rb index 4f3a25f5..8132ed03 100644 --- a/lib/orb/models/alert_list_params.rb +++ b/lib/orb/models/alert_list_params.rb @@ -30,7 +30,7 @@ class AlertListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/alert_update_params.rb b/lib/orb/models/alert_update_params.rb index 07ed0c15..9827962a 100644 --- a/lib/orb/models/alert_update_params.rb +++ b/lib/orb/models/alert_update_params.rb @@ -25,15 +25,15 @@ class AlertUpdateParams < Orb::Internal::Type::BaseModel class Threshold < Orb::Internal::Type::BaseModel # @!attribute value # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. # # @return [Float] required :value, Float # @!parse # # Thresholds are used to define the conditions under which an alert will be - # # triggered. + # # triggered. # # # # @param value [Float] # # diff --git a/lib/orb/models/amount_discount.rb b/lib/orb/models/amount_discount.rb index 7279f6f6..e4cd8fc1 100644 --- a/lib/orb/models/amount_discount.rb +++ b/lib/orb/models/amount_discount.rb @@ -11,7 +11,7 @@ class AmountDiscount < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this discount applies to. For plan/plan phase discounts, - # this can be a subset of prices. + # this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] diff --git a/lib/orb/models/billable_metric.rb b/lib/orb/models/billable_metric.rb index 6cca39e5..11e201c1 100644 --- a/lib/orb/models/billable_metric.rb +++ b/lib/orb/models/billable_metric.rb @@ -16,17 +16,17 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @!attribute item # The Item resource represents a sellable product or good. Items are associated - # with all line items, billable metrics, and prices and are used for defining - # external sync behavior for invoices and tax calculation purposes. + # with all line items, billable metrics, and prices and are used for defining + # external sync behavior for invoices and tax calculation purposes. # # @return [Orb::Models::Item] required :item, -> { Orb::Models::Item } # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -43,8 +43,8 @@ class BillableMetric < Orb::Internal::Type::BaseModel # @!parse # # The Metric resource represents a calculation of a quantity based on events. - # # Metrics are defined by the query that transforms raw usage events into - # # meaningful values for your customers. + # # Metrics are defined by the query that transforms raw usage events into + # # meaningful values for your customers. # # # # @param id [String] # # @param description [String, nil] diff --git a/lib/orb/models/coupon.rb b/lib/orb/models/coupon.rb index 3f5ab6ed..0e0c71cc 100644 --- a/lib/orb/models/coupon.rb +++ b/lib/orb/models/coupon.rb @@ -12,7 +12,7 @@ class Coupon < Orb::Internal::Type::BaseModel # @!attribute archived_at # An archived coupon can no longer be redeemed. Active coupons will have a value - # of null for `archived_at`; this field will be non-null for archived coupons. + # of null for `archived_at`; this field will be non-null for archived coupons. # # @return [Time, nil] required :archived_at, Time, nil?: true @@ -24,14 +24,14 @@ class Coupon < Orb::Internal::Type::BaseModel # @!attribute duration_in_months # This allows for a coupon's discount to apply for a limited time (determined in - # months); a `null` value here means "unlimited time". + # months); a `null` value here means "unlimited time". # # @return [Integer, nil] required :duration_in_months, Integer, nil?: true # @!attribute max_redemptions # The maximum number of redemptions allowed for this coupon before it is - # exhausted; `null` here means "unlimited". + # exhausted; `null` here means "unlimited". # # @return [Integer, nil] required :max_redemptions, Integer, nil?: true @@ -50,10 +50,10 @@ class Coupon < Orb::Internal::Type::BaseModel # @!parse # # A coupon represents a reusable discount configuration that can be applied either - # # as a fixed or percentage amount to an invoice or subscription. Coupons are - # # activated using a redemption code, which applies the discount to a subscription - # # or invoice. The duration of a coupon determines how long it remains available - # # for use by end users. + # # as a fixed or percentage amount to an invoice or subscription. Coupons are + # # activated using a redemption code, which applies the discount to a subscription + # # or invoice. The duration of a coupon determines how long it remains available + # # for use by end users. # # # # @param id [String] # # @param archived_at [Time, nil] diff --git a/lib/orb/models/coupon_create_params.rb b/lib/orb/models/coupon_create_params.rb index a8f66d16..39ef9676 100644 --- a/lib/orb/models/coupon_create_params.rb +++ b/lib/orb/models/coupon_create_params.rb @@ -21,14 +21,14 @@ class CouponCreateParams < Orb::Internal::Type::BaseModel # @!attribute duration_in_months # This allows for a coupon's discount to apply for a limited time (determined in - # months); a `null` value here means "unlimited time". + # months); a `null` value here means "unlimited time". # # @return [Integer, nil] optional :duration_in_months, Integer, nil?: true # @!attribute max_redemptions # The maximum number of redemptions allowed for this coupon before it is - # exhausted;`null` here means "unlimited". + # exhausted;`null` here means "unlimited". # # @return [Integer, nil] optional :max_redemptions, Integer, nil?: true diff --git a/lib/orb/models/coupon_list_params.rb b/lib/orb/models/coupon_list_params.rb index dfc8f201..7f417722 100644 --- a/lib/orb/models/coupon_list_params.rb +++ b/lib/orb/models/coupon_list_params.rb @@ -10,7 +10,7 @@ class CouponListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true @@ -33,7 +33,7 @@ class CouponListParams < Orb::Internal::Type::BaseModel # @!attribute show_archived # Show archived coupons as well (by default, this endpoint only returns active - # coupons). + # coupons). # # @return [Boolean, nil] optional :show_archived, Orb::Internal::Type::Boolean, nil?: true diff --git a/lib/orb/models/coupons/subscription_list_params.rb b/lib/orb/models/coupons/subscription_list_params.rb index f4d61b01..e47258fc 100644 --- a/lib/orb/models/coupons/subscription_list_params.rb +++ b/lib/orb/models/coupons/subscription_list_params.rb @@ -11,7 +11,7 @@ class SubscriptionListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/credit_note.rb b/lib/orb/models/credit_note.rb index 2f6f6cb8..726fadc0 100644 --- a/lib/orb/models/credit_note.rb +++ b/lib/orb/models/credit_note.rb @@ -103,7 +103,7 @@ class CreditNote < Orb::Internal::Type::BaseModel # @!parse # # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has - # # been applied to a particular invoice. + # # been applied to a particular invoice. # # # # @param id [String] # # @param created_at [Time] diff --git a/lib/orb/models/credit_note_list_params.rb b/lib/orb/models/credit_note_list_params.rb index e9e7c935..7e634598 100644 --- a/lib/orb/models/credit_note_list_params.rb +++ b/lib/orb/models/credit_note_list_params.rb @@ -30,7 +30,7 @@ class CreditNoteListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/customer.rb b/lib/orb/models/customer.rb index 7dd69115..27e5c6d8 100644 --- a/lib/orb/models/customer.rb +++ b/lib/orb/models/customer.rb @@ -42,8 +42,8 @@ class Customer < Orb::Internal::Type::BaseModel # @!attribute email # A valid customer email, to be used for notifications. When Orb triggers payment - # through a payment gateway, this email will be used for any automatically issued - # receipts. + # through a payment gateway, this email will be used for any automatically issued + # receipts. # # @return [String] required :email, String @@ -60,8 +60,8 @@ class Customer < Orb::Internal::Type::BaseModel # @!attribute external_customer_id # An optional user-defined ID for this customer resource, used throughout the - # system as an alias for this Customer. Use this field to identify a customer by - # an existing identifier in your system. + # system as an alias for this Customer. Use this field to identify a customer by + # an existing identifier in your system. # # @return [String, nil] required :external_customer_id, String, nil?: true @@ -74,9 +74,9 @@ class Customer < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -89,15 +89,15 @@ class Customer < Orb::Internal::Type::BaseModel # @!attribute payment_provider # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode, the connection must first be configured in the Orb - # webapp. + # When not in test mode, the connection must first be configured in the Orb + # webapp. # # @return [Symbol, Orb::Models::Customer::PaymentProvider, nil] required :payment_provider, enum: -> { Orb::Models::Customer::PaymentProvider }, nil?: true # @!attribute payment_provider_id # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. # # @return [String, nil] required :payment_provider_id, String, nil?: true @@ -114,118 +114,118 @@ class Customer < Orb::Internal::Type::BaseModel # @!attribute tax_id # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # @return [Orb::Models::Customer::TaxID, nil] required :tax_id, -> { Orb::Models::Customer::TaxID }, nil?: true # @!attribute timezone # A timezone identifier from the IANA timezone database, such as - # "America/Los_Angeles". This "defaults to your account's timezone if not set. - # This cannot be changed after customer creation. + # "America/Los_Angeles". This "defaults to your account's timezone if not set. + # This cannot be changed after customer creation. # # @return [String] required :timezone, String @@ -244,23 +244,23 @@ class Customer < Orb::Internal::Type::BaseModel # @!parse # # A customer is a buyer of your products, and the other party to the billing - # # relationship. + # # relationship. # # - # # In Orb, customers are assigned system generated identifiers automatically, but - # # it's often desirable to have these match existing identifiers in your system. To - # # avoid having to denormalize Orb ID information, you can pass in an - # # `external_customer_id` with your own identifier. See - # # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # # information about how these aliases work in Orb. + # # In Orb, customers are assigned system generated identifiers automatically, but + # # it's often desirable to have these match existing identifiers in your system. To + # # avoid having to denormalize Orb ID information, you can pass in an + # # `external_customer_id` with your own identifier. See + # # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # # information about how these aliases work in Orb. # # - # # In addition to having an identifier in your system, a customer may exist in a - # # payment provider solution like Stripe. Use the `payment_provider_id` and the - # # `payment_provider` enum field to express this mapping. + # # In addition to having an identifier in your system, a customer may exist in a + # # payment provider solution like Stripe. Use the `payment_provider_id` and the + # # `payment_provider` enum field to express this mapping. # # - # # A customer also has a timezone (from the standard - # # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # # your account's timezone. See [Timezone localization](/essentials/timezones) for - # # information on what this timezone parameter influences within Orb. + # # A customer also has a timezone (from the standard + # # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # # your account's timezone. See [Timezone localization](/essentials/timezones) for + # # information on what this timezone parameter influences within Orb. # # # # @param id [String] # # @param additional_emails [Array] @@ -425,8 +425,8 @@ class Parent < Orb::Internal::Type::BaseModel end # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode, the connection must first be configured in the Orb - # webapp. + # When not in test mode, the connection must first be configured in the Orb + # webapp. # # @see Orb::Models::Customer#payment_provider module PaymentProvider @@ -509,110 +509,110 @@ class TaxID < Orb::Internal::Type::BaseModel # @!parse # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. + # # added to the headers of invoices. # # - # # ### Supported Tax ID Countries and Types + # # ### Supported Tax ID Countries and Types # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # # | Country | Type | Description | + # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # # | Andorra | `ad_nrt` | Andorran NRT Number | + # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # # | Austria | `eu_vat` | European VAT Number | + # # | Bahrain | `bh_vat` | Bahraini VAT Number | + # # | Belgium | `eu_vat` | European VAT Number | + # # | Bolivia | `bo_tin` | Bolivian Tax ID | + # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # # | Brazil | `br_cpf` | Brazilian CPF Number | + # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # # | Bulgaria | `eu_vat` | European VAT Number | + # # | Canada | `ca_bn` | Canadian BN | + # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # # | Chile | `cl_tin` | Chilean TIN | + # # | China | `cn_tin` | Chinese Tax ID | + # # | Colombia | `co_nit` | Colombian NIT Number | + # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # # | Croatia | `eu_vat` | European VAT Number | + # # | Cyprus | `eu_vat` | European VAT Number | + # # | Czech Republic | `eu_vat` | European VAT Number | + # # | Denmark | `eu_vat` | European VAT Number | + # # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # # | Estonia | `eu_vat` | European VAT Number | + # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # # | Finland | `eu_vat` | European VAT Number | + # # | France | `eu_vat` | European VAT Number | + # # | Georgia | `ge_vat` | Georgian VAT | + # # | Germany | `eu_vat` | European VAT Number | + # # | Greece | `eu_vat` | European VAT Number | + # # | Hong Kong | `hk_br` | Hong Kong BR Number | + # # | Hungary | `eu_vat` | European VAT Number | + # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # # | Iceland | `is_vat` | Icelandic VAT | + # # | India | `in_gst` | Indian GST Number | + # # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # # | Ireland | `eu_vat` | European VAT Number | + # # | Israel | `il_vat` | Israel VAT | + # # | Italy | `eu_vat` | European VAT Number | + # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # # | Latvia | `eu_vat` | European VAT Number | + # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # # | Lithuania | `eu_vat` | European VAT Number | + # # | Luxembourg | `eu_vat` | European VAT Number | + # # | Malaysia | `my_frp` | Malaysian FRP Number | + # # | Malaysia | `my_itn` | Malaysian ITN | + # # | Malaysia | `my_sst` | Malaysian SST Number | + # # | Malta | `eu_vat ` | European VAT Number | + # # | Mexico | `mx_rfc` | Mexican RFC Number | + # # | Netherlands | `eu_vat` | European VAT Number | + # # | New Zealand | `nz_gst` | New Zealand GST Number | + # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # # | Norway | `no_vat` | Norwegian VAT Number | + # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # # | Oman | `om_vat` | Omani VAT Number | + # # | Peru | `pe_ruc` | Peruvian RUC Number | + # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # # | Poland | `eu_vat` | European VAT Number | + # # | Portugal | `eu_vat` | European VAT Number | + # # | Romania | `eu_vat` | European VAT Number | + # # | Romania | `ro_tin` | Romanian Tax ID Number | + # # | Russia | `ru_inn` | Russian INN | + # # | Russia | `ru_kpp` | Russian KPP | + # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # # | Serbia | `rs_pib` | Serbian PIB Number | + # # | Singapore | `sg_gst` | Singaporean GST | + # # | Singapore | `sg_uen` | Singaporean UEN | + # # | Slovakia | `eu_vat` | European VAT Number | + # # | Slovenia | `eu_vat` | European VAT Number | + # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # # | South Africa | `za_vat` | South African VAT Number | + # # | South Korea | `kr_brn` | Korean BRN | + # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # # | Spain | `eu_vat` | European VAT Number | + # # | Sweden | `eu_vat` | European VAT Number | + # # | Switzerland | `ch_vat` | Switzerland VAT Number | + # # | Taiwan | `tw_vat` | Taiwanese VAT | + # # | Thailand | `th_vat` | Thai VAT | + # # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # # | Ukraine | `ua_vat` | Ukrainian VAT | + # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # # | United States | `us_ein` | United States EIN | + # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # # # @param country [Symbol, Orb::Models::Customer::TaxID::Country] # # @param type [Symbol, Orb::Models::Customer::TaxID::Type] diff --git a/lib/orb/models/customer_create_params.rb b/lib/orb/models/customer_create_params.rb index 0e0f335d..d239bc23 100644 --- a/lib/orb/models/customer_create_params.rb +++ b/lib/orb/models/customer_create_params.rb @@ -10,8 +10,8 @@ class CustomerCreateParams < Orb::Internal::Type::BaseModel # @!attribute email # A valid customer email, to be used for notifications. When Orb triggers payment - # through a payment gateway, this email will be used for any automatically issued - # receipts. + # through a payment gateway, this email will be used for any automatically issued + # receipts. # # @return [String] required :email, String @@ -31,15 +31,15 @@ class CustomerCreateParams < Orb::Internal::Type::BaseModel # @!attribute additional_emails # Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. + # addresses will be CC'd for customer communications. # # @return [Array, nil] optional :additional_emails, Orb::Internal::Type::ArrayOf[String], nil?: true # @!attribute auto_collection # Used to determine if invoices for this customer will automatically attempt to - # charge a saved payment method, if available. This parameter defaults to `True` - # when a payment provider is provided on customer creation. + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. # # @return [Boolean, nil] optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -51,7 +51,7 @@ class CustomerCreateParams < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string used for the customer's invoices and balance. If not - # set at creation time, will be set at subscription creation time. + # set at creation time, will be set at subscription creation time. # # @return [String, nil] optional :currency, String, nil?: true @@ -63,8 +63,8 @@ class CustomerCreateParams < Orb::Internal::Type::BaseModel # @!attribute external_customer_id # An optional user-defined ID for this customer resource, used throughout the - # system as an alias for this Customer. Use this field to identify a customer by - # an existing identifier in your system. + # system as an alias for this Customer. Use this field to identify a customer by + # an existing identifier in your system. # # @return [String, nil] optional :external_customer_id, String, nil?: true @@ -77,23 +77,23 @@ class CustomerCreateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute payment_provider # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode, the connection must first be configured in the Orb - # webapp. + # When not in test mode, the connection must first be configured in the Orb + # webapp. # # @return [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] optional :payment_provider, enum: -> { Orb::Models::CustomerCreateParams::PaymentProvider }, nil?: true # @!attribute payment_provider_id # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. # # @return [String, nil] optional :payment_provider_id, String, nil?: true @@ -117,118 +117,118 @@ class CustomerCreateParams < Orb::Internal::Type::BaseModel # @!attribute tax_id # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # @return [Orb::Models::CustomerCreateParams::TaxID, nil] optional :tax_id, -> { Orb::Models::CustomerCreateParams::TaxID }, nil?: true # @!attribute timezone # A timezone identifier from the IANA timezone database, such as - # `"America/Los_Angeles"`. This defaults to your account's timezone if not set. - # This cannot be changed after customer creation. + # `"America/Los_Angeles"`. This defaults to your account's timezone if not set. + # This cannot be changed after customer creation. # # @return [String, nil] optional :timezone, String, nil?: true @@ -370,7 +370,7 @@ class BillingAddress < Orb::Internal::Type::BaseModel class Hierarchy < Orb::Internal::Type::BaseModel # @!attribute [r] child_customer_ids # A list of child customer IDs to add to the hierarchy. The desired child - # customers must not already be part of another hierarchy. + # customers must not already be part of another hierarchy. # # @return [Array, nil] optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String] @@ -381,7 +381,7 @@ class Hierarchy < Orb::Internal::Type::BaseModel # @!attribute parent_customer_id # The ID of the parent customer in the hierarchy. The desired parent customer must - # not be a child of another customer. + # not be a child of another customer. # # @return [String, nil] optional :parent_customer_id, String, nil?: true @@ -398,8 +398,8 @@ class Hierarchy < Orb::Internal::Type::BaseModel end # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode, the connection must first be configured in the Orb - # webapp. + # When not in test mode, the connection must first be configured in the Orb + # webapp. module PaymentProvider extend Orb::Internal::Type::Enum @@ -552,110 +552,110 @@ class TaxID < Orb::Internal::Type::BaseModel # @!parse # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. + # # added to the headers of invoices. # # - # # ### Supported Tax ID Countries and Types + # # ### Supported Tax ID Countries and Types # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # # | Country | Type | Description | + # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # # | Andorra | `ad_nrt` | Andorran NRT Number | + # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # # | Austria | `eu_vat` | European VAT Number | + # # | Bahrain | `bh_vat` | Bahraini VAT Number | + # # | Belgium | `eu_vat` | European VAT Number | + # # | Bolivia | `bo_tin` | Bolivian Tax ID | + # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # # | Brazil | `br_cpf` | Brazilian CPF Number | + # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # # | Bulgaria | `eu_vat` | European VAT Number | + # # | Canada | `ca_bn` | Canadian BN | + # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # # | Chile | `cl_tin` | Chilean TIN | + # # | China | `cn_tin` | Chinese Tax ID | + # # | Colombia | `co_nit` | Colombian NIT Number | + # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # # | Croatia | `eu_vat` | European VAT Number | + # # | Cyprus | `eu_vat` | European VAT Number | + # # | Czech Republic | `eu_vat` | European VAT Number | + # # | Denmark | `eu_vat` | European VAT Number | + # # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # # | Estonia | `eu_vat` | European VAT Number | + # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # # | Finland | `eu_vat` | European VAT Number | + # # | France | `eu_vat` | European VAT Number | + # # | Georgia | `ge_vat` | Georgian VAT | + # # | Germany | `eu_vat` | European VAT Number | + # # | Greece | `eu_vat` | European VAT Number | + # # | Hong Kong | `hk_br` | Hong Kong BR Number | + # # | Hungary | `eu_vat` | European VAT Number | + # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # # | Iceland | `is_vat` | Icelandic VAT | + # # | India | `in_gst` | Indian GST Number | + # # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # # | Ireland | `eu_vat` | European VAT Number | + # # | Israel | `il_vat` | Israel VAT | + # # | Italy | `eu_vat` | European VAT Number | + # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # # | Latvia | `eu_vat` | European VAT Number | + # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # # | Lithuania | `eu_vat` | European VAT Number | + # # | Luxembourg | `eu_vat` | European VAT Number | + # # | Malaysia | `my_frp` | Malaysian FRP Number | + # # | Malaysia | `my_itn` | Malaysian ITN | + # # | Malaysia | `my_sst` | Malaysian SST Number | + # # | Malta | `eu_vat ` | European VAT Number | + # # | Mexico | `mx_rfc` | Mexican RFC Number | + # # | Netherlands | `eu_vat` | European VAT Number | + # # | New Zealand | `nz_gst` | New Zealand GST Number | + # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # # | Norway | `no_vat` | Norwegian VAT Number | + # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # # | Oman | `om_vat` | Omani VAT Number | + # # | Peru | `pe_ruc` | Peruvian RUC Number | + # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # # | Poland | `eu_vat` | European VAT Number | + # # | Portugal | `eu_vat` | European VAT Number | + # # | Romania | `eu_vat` | European VAT Number | + # # | Romania | `ro_tin` | Romanian Tax ID Number | + # # | Russia | `ru_inn` | Russian INN | + # # | Russia | `ru_kpp` | Russian KPP | + # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # # | Serbia | `rs_pib` | Serbian PIB Number | + # # | Singapore | `sg_gst` | Singaporean GST | + # # | Singapore | `sg_uen` | Singaporean UEN | + # # | Slovakia | `eu_vat` | European VAT Number | + # # | Slovenia | `eu_vat` | European VAT Number | + # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # # | South Africa | `za_vat` | South African VAT Number | + # # | South Korea | `kr_brn` | Korean BRN | + # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # # | Spain | `eu_vat` | European VAT Number | + # # | Sweden | `eu_vat` | European VAT Number | + # # | Switzerland | `ch_vat` | Switzerland VAT Number | + # # | Taiwan | `tw_vat` | Taiwanese VAT | + # # | Thailand | `th_vat` | Thai VAT | + # # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # # | Ukraine | `ua_vat` | Ukrainian VAT | + # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # # | United States | `us_ein` | United States EIN | + # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # # # @param country [Symbol, Orb::Models::CustomerCreateParams::TaxID::Country] # # @param type [Symbol, Orb::Models::CustomerCreateParams::TaxID::Type] diff --git a/lib/orb/models/customer_list_params.rb b/lib/orb/models/customer_list_params.rb index a69c3260..181dd8a9 100644 --- a/lib/orb/models/customer_list_params.rb +++ b/lib/orb/models/customer_list_params.rb @@ -30,7 +30,7 @@ class CustomerListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true 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 af19e54a..d8562ebb 100644 --- a/lib/orb/models/customer_update_by_external_id_params.rb +++ b/lib/orb/models/customer_update_by_external_id_params.rb @@ -17,15 +17,15 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute additional_emails # Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. + # addresses will be CC'd for customer communications. # # @return [Array, nil] optional :additional_emails, Orb::Internal::Type::ArrayOf[String], nil?: true # @!attribute auto_collection # Used to determine if invoices for this customer will automatically attempt to - # charge a saved payment method, if available. This parameter defaults to `True` - # when a payment provider is provided on customer creation. + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. # # @return [Boolean, nil] optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -39,7 +39,7 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string used for the customer's invoices and balance. If not - # set at creation time, will be set at subscription creation time. + # set at creation time, will be set at subscription creation time. # # @return [String, nil] optional :currency, String, nil?: true @@ -57,7 +57,7 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute external_customer_id # The external customer ID. This can only be set if empty and the customer has no - # past or current subscriptions. + # past or current subscriptions. # # @return [String, nil] optional :external_customer_id, String, nil?: true @@ -70,8 +70,8 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -84,12 +84,12 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute payment_provider # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. # # @return [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] optional :payment_provider, @@ -98,7 +98,7 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute payment_provider_id # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. # # @return [String, nil] optional :payment_provider_id, String, nil?: true @@ -126,110 +126,110 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute tax_id # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] optional :tax_id, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxID }, nil?: true @@ -369,7 +369,7 @@ class BillingAddress < Orb::Internal::Type::BaseModel class Hierarchy < Orb::Internal::Type::BaseModel # @!attribute [r] child_customer_ids # A list of child customer IDs to add to the hierarchy. The desired child - # customers must not already be part of another hierarchy. + # customers must not already be part of another hierarchy. # # @return [Array, nil] optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String] @@ -380,7 +380,7 @@ class Hierarchy < Orb::Internal::Type::BaseModel # @!attribute parent_customer_id # The ID of the parent customer in the hierarchy. The desired parent customer must - # not be a child of another customer. + # not be a child of another customer. # # @return [String, nil] optional :parent_customer_id, String, nil?: true @@ -397,12 +397,12 @@ class Hierarchy < Orb::Internal::Type::BaseModel end # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. module PaymentProvider extend Orb::Internal::Type::Enum @@ -557,110 +557,110 @@ class TaxID < Orb::Internal::Type::BaseModel # @!parse # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. + # # added to the headers of invoices. # # - # # ### Supported Tax ID Countries and Types + # # ### Supported Tax ID Countries and Types # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # # | Country | Type | Description | + # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # # | Andorra | `ad_nrt` | Andorran NRT Number | + # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # # | Austria | `eu_vat` | European VAT Number | + # # | Bahrain | `bh_vat` | Bahraini VAT Number | + # # | Belgium | `eu_vat` | European VAT Number | + # # | Bolivia | `bo_tin` | Bolivian Tax ID | + # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # # | Brazil | `br_cpf` | Brazilian CPF Number | + # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # # | Bulgaria | `eu_vat` | European VAT Number | + # # | Canada | `ca_bn` | Canadian BN | + # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # # | Chile | `cl_tin` | Chilean TIN | + # # | China | `cn_tin` | Chinese Tax ID | + # # | Colombia | `co_nit` | Colombian NIT Number | + # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # # | Croatia | `eu_vat` | European VAT Number | + # # | Cyprus | `eu_vat` | European VAT Number | + # # | Czech Republic | `eu_vat` | European VAT Number | + # # | Denmark | `eu_vat` | European VAT Number | + # # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # # | Estonia | `eu_vat` | European VAT Number | + # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # # | Finland | `eu_vat` | European VAT Number | + # # | France | `eu_vat` | European VAT Number | + # # | Georgia | `ge_vat` | Georgian VAT | + # # | Germany | `eu_vat` | European VAT Number | + # # | Greece | `eu_vat` | European VAT Number | + # # | Hong Kong | `hk_br` | Hong Kong BR Number | + # # | Hungary | `eu_vat` | European VAT Number | + # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # # | Iceland | `is_vat` | Icelandic VAT | + # # | India | `in_gst` | Indian GST Number | + # # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # # | Ireland | `eu_vat` | European VAT Number | + # # | Israel | `il_vat` | Israel VAT | + # # | Italy | `eu_vat` | European VAT Number | + # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # # | Latvia | `eu_vat` | European VAT Number | + # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # # | Lithuania | `eu_vat` | European VAT Number | + # # | Luxembourg | `eu_vat` | European VAT Number | + # # | Malaysia | `my_frp` | Malaysian FRP Number | + # # | Malaysia | `my_itn` | Malaysian ITN | + # # | Malaysia | `my_sst` | Malaysian SST Number | + # # | Malta | `eu_vat ` | European VAT Number | + # # | Mexico | `mx_rfc` | Mexican RFC Number | + # # | Netherlands | `eu_vat` | European VAT Number | + # # | New Zealand | `nz_gst` | New Zealand GST Number | + # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # # | Norway | `no_vat` | Norwegian VAT Number | + # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # # | Oman | `om_vat` | Omani VAT Number | + # # | Peru | `pe_ruc` | Peruvian RUC Number | + # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # # | Poland | `eu_vat` | European VAT Number | + # # | Portugal | `eu_vat` | European VAT Number | + # # | Romania | `eu_vat` | European VAT Number | + # # | Romania | `ro_tin` | Romanian Tax ID Number | + # # | Russia | `ru_inn` | Russian INN | + # # | Russia | `ru_kpp` | Russian KPP | + # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # # | Serbia | `rs_pib` | Serbian PIB Number | + # # | Singapore | `sg_gst` | Singaporean GST | + # # | Singapore | `sg_uen` | Singaporean UEN | + # # | Slovakia | `eu_vat` | European VAT Number | + # # | Slovenia | `eu_vat` | European VAT Number | + # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # # | South Africa | `za_vat` | South African VAT Number | + # # | South Korea | `kr_brn` | Korean BRN | + # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # # | Spain | `eu_vat` | European VAT Number | + # # | Sweden | `eu_vat` | European VAT Number | + # # | Switzerland | `ch_vat` | Switzerland VAT Number | + # # | Taiwan | `tw_vat` | Taiwanese VAT | + # # | Thailand | `th_vat` | Thai VAT | + # # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # # | Ukraine | `ua_vat` | Ukrainian VAT | + # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # # | United States | `us_ein` | United States EIN | + # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # # # @param country [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country] # # @param type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type] diff --git a/lib/orb/models/customer_update_params.rb b/lib/orb/models/customer_update_params.rb index 98675d14..e23fb54b 100644 --- a/lib/orb/models/customer_update_params.rb +++ b/lib/orb/models/customer_update_params.rb @@ -17,15 +17,15 @@ class CustomerUpdateParams < Orb::Internal::Type::BaseModel # @!attribute additional_emails # Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. + # addresses will be CC'd for customer communications. # # @return [Array, nil] optional :additional_emails, Orb::Internal::Type::ArrayOf[String], nil?: true # @!attribute auto_collection # Used to determine if invoices for this customer will automatically attempt to - # charge a saved payment method, if available. This parameter defaults to `True` - # when a payment provider is provided on customer creation. + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. # # @return [Boolean, nil] optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -37,7 +37,7 @@ class CustomerUpdateParams < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string used for the customer's invoices and balance. If not - # set at creation time, will be set at subscription creation time. + # set at creation time, will be set at subscription creation time. # # @return [String, nil] optional :currency, String, nil?: true @@ -55,7 +55,7 @@ class CustomerUpdateParams < Orb::Internal::Type::BaseModel # @!attribute external_customer_id # The external customer ID. This can only be set if empty and the customer has no - # past or current subscriptions. + # past or current subscriptions. # # @return [String, nil] optional :external_customer_id, String, nil?: true @@ -68,8 +68,8 @@ class CustomerUpdateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -82,19 +82,19 @@ class CustomerUpdateParams < Orb::Internal::Type::BaseModel # @!attribute payment_provider # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. # # @return [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] optional :payment_provider, enum: -> { Orb::Models::CustomerUpdateParams::PaymentProvider }, nil?: true # @!attribute payment_provider_id # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. # # @return [String, nil] optional :payment_provider_id, String, nil?: true @@ -118,110 +118,110 @@ class CustomerUpdateParams < Orb::Internal::Type::BaseModel # @!attribute tax_id # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # @return [Orb::Models::CustomerUpdateParams::TaxID, nil] optional :tax_id, -> { Orb::Models::CustomerUpdateParams::TaxID }, nil?: true @@ -361,7 +361,7 @@ class BillingAddress < Orb::Internal::Type::BaseModel class Hierarchy < Orb::Internal::Type::BaseModel # @!attribute [r] child_customer_ids # A list of child customer IDs to add to the hierarchy. The desired child - # customers must not already be part of another hierarchy. + # customers must not already be part of another hierarchy. # # @return [Array, nil] optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String] @@ -372,7 +372,7 @@ class Hierarchy < Orb::Internal::Type::BaseModel # @!attribute parent_customer_id # The ID of the parent customer in the hierarchy. The desired parent customer must - # not be a child of another customer. + # not be a child of another customer. # # @return [String, nil] optional :parent_customer_id, String, nil?: true @@ -389,12 +389,12 @@ class Hierarchy < Orb::Internal::Type::BaseModel end # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. module PaymentProvider extend Orb::Internal::Type::Enum @@ -547,110 +547,110 @@ class TaxID < Orb::Internal::Type::BaseModel # @!parse # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. + # # added to the headers of invoices. # # - # # ### Supported Tax ID Countries and Types + # # ### Supported Tax ID Countries and Types # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # # | Country | Type | Description | + # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # # | Andorra | `ad_nrt` | Andorran NRT Number | + # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # # | Austria | `eu_vat` | European VAT Number | + # # | Bahrain | `bh_vat` | Bahraini VAT Number | + # # | Belgium | `eu_vat` | European VAT Number | + # # | Bolivia | `bo_tin` | Bolivian Tax ID | + # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # # | Brazil | `br_cpf` | Brazilian CPF Number | + # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # # | Bulgaria | `eu_vat` | European VAT Number | + # # | Canada | `ca_bn` | Canadian BN | + # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # # | Chile | `cl_tin` | Chilean TIN | + # # | China | `cn_tin` | Chinese Tax ID | + # # | Colombia | `co_nit` | Colombian NIT Number | + # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # # | Croatia | `eu_vat` | European VAT Number | + # # | Cyprus | `eu_vat` | European VAT Number | + # # | Czech Republic | `eu_vat` | European VAT Number | + # # | Denmark | `eu_vat` | European VAT Number | + # # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # # | Estonia | `eu_vat` | European VAT Number | + # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # # | Finland | `eu_vat` | European VAT Number | + # # | France | `eu_vat` | European VAT Number | + # # | Georgia | `ge_vat` | Georgian VAT | + # # | Germany | `eu_vat` | European VAT Number | + # # | Greece | `eu_vat` | European VAT Number | + # # | Hong Kong | `hk_br` | Hong Kong BR Number | + # # | Hungary | `eu_vat` | European VAT Number | + # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # # | Iceland | `is_vat` | Icelandic VAT | + # # | India | `in_gst` | Indian GST Number | + # # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # # | Ireland | `eu_vat` | European VAT Number | + # # | Israel | `il_vat` | Israel VAT | + # # | Italy | `eu_vat` | European VAT Number | + # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # # | Latvia | `eu_vat` | European VAT Number | + # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # # | Lithuania | `eu_vat` | European VAT Number | + # # | Luxembourg | `eu_vat` | European VAT Number | + # # | Malaysia | `my_frp` | Malaysian FRP Number | + # # | Malaysia | `my_itn` | Malaysian ITN | + # # | Malaysia | `my_sst` | Malaysian SST Number | + # # | Malta | `eu_vat ` | European VAT Number | + # # | Mexico | `mx_rfc` | Mexican RFC Number | + # # | Netherlands | `eu_vat` | European VAT Number | + # # | New Zealand | `nz_gst` | New Zealand GST Number | + # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # # | Norway | `no_vat` | Norwegian VAT Number | + # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # # | Oman | `om_vat` | Omani VAT Number | + # # | Peru | `pe_ruc` | Peruvian RUC Number | + # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # # | Poland | `eu_vat` | European VAT Number | + # # | Portugal | `eu_vat` | European VAT Number | + # # | Romania | `eu_vat` | European VAT Number | + # # | Romania | `ro_tin` | Romanian Tax ID Number | + # # | Russia | `ru_inn` | Russian INN | + # # | Russia | `ru_kpp` | Russian KPP | + # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # # | Serbia | `rs_pib` | Serbian PIB Number | + # # | Singapore | `sg_gst` | Singaporean GST | + # # | Singapore | `sg_uen` | Singaporean UEN | + # # | Slovakia | `eu_vat` | European VAT Number | + # # | Slovenia | `eu_vat` | European VAT Number | + # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # # | South Africa | `za_vat` | South African VAT Number | + # # | South Korea | `kr_brn` | Korean BRN | + # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # # | Spain | `eu_vat` | European VAT Number | + # # | Sweden | `eu_vat` | European VAT Number | + # # | Switzerland | `ch_vat` | Switzerland VAT Number | + # # | Taiwan | `tw_vat` | Taiwanese VAT | + # # | Thailand | `th_vat` | Thai VAT | + # # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # # | Ukraine | `ua_vat` | Ukrainian VAT | + # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # # | United States | `us_ein` | United States EIN | + # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # # # @param country [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country] # # @param type [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type] diff --git a/lib/orb/models/customers/balance_transaction_create_response.rb b/lib/orb/models/customers/balance_transaction_create_response.rb index a518866d..e5954af4 100644 --- a/lib/orb/models/customers/balance_transaction_create_response.rb +++ b/lib/orb/models/customers/balance_transaction_create_response.rb @@ -43,7 +43,7 @@ class BalanceTransactionCreateResponse < Orb::Internal::Type::BaseModel # @!attribute ending_balance # The new value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. # # @return [String] required :ending_balance, String @@ -55,7 +55,7 @@ class BalanceTransactionCreateResponse < Orb::Internal::Type::BaseModel # @!attribute starting_balance # The original value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. # # @return [String] required :starting_balance, String diff --git a/lib/orb/models/customers/balance_transaction_list_params.rb b/lib/orb/models/customers/balance_transaction_list_params.rb index 0418c92b..7eb4ac10 100644 --- a/lib/orb/models/customers/balance_transaction_list_params.rb +++ b/lib/orb/models/customers/balance_transaction_list_params.rb @@ -11,7 +11,7 @@ class BalanceTransactionListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/customers/balance_transaction_list_response.rb b/lib/orb/models/customers/balance_transaction_list_response.rb index 4b776189..ac56f84e 100644 --- a/lib/orb/models/customers/balance_transaction_list_response.rb +++ b/lib/orb/models/customers/balance_transaction_list_response.rb @@ -43,7 +43,7 @@ class BalanceTransactionListResponse < Orb::Internal::Type::BaseModel # @!attribute ending_balance # The new value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. # # @return [String] required :ending_balance, String @@ -55,7 +55,7 @@ class BalanceTransactionListResponse < Orb::Internal::Type::BaseModel # @!attribute starting_balance # The original value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. # # @return [String] required :starting_balance, String diff --git a/lib/orb/models/customers/cost_list_by_external_id_params.rb b/lib/orb/models/customers/cost_list_by_external_id_params.rb index 56889898..306dd37a 100644 --- a/lib/orb/models/customers/cost_list_by_external_id_params.rb +++ b/lib/orb/models/customers/cost_list_by_external_id_params.rb @@ -29,9 +29,9 @@ class CostListByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute view_mode # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. # # @return [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] optional :view_mode, enum: -> { Orb::Models::Customers::CostListByExternalIDParams::ViewMode }, nil?: true @@ -48,9 +48,9 @@ class CostListByExternalIDParams < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. module ViewMode extend Orb::Internal::Type::Enum diff --git a/lib/orb/models/customers/cost_list_params.rb b/lib/orb/models/customers/cost_list_params.rb index 8e06ec01..d602b340 100644 --- a/lib/orb/models/customers/cost_list_params.rb +++ b/lib/orb/models/customers/cost_list_params.rb @@ -29,9 +29,9 @@ class CostListParams < Orb::Internal::Type::BaseModel # @!attribute view_mode # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. # # @return [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] optional :view_mode, enum: -> { Orb::Models::Customers::CostListParams::ViewMode }, nil?: true @@ -48,9 +48,9 @@ class CostListParams < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. module ViewMode extend Orb::Internal::Type::Enum diff --git a/lib/orb/models/customers/credit_list_by_external_id_params.rb b/lib/orb/models/customers/credit_list_by_external_id_params.rb index 9d8f4730..f943e0fc 100644 --- a/lib/orb/models/customers/credit_list_by_external_id_params.rb +++ b/lib/orb/models/customers/credit_list_by_external_id_params.rb @@ -17,14 +17,14 @@ class CreditListByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true # @!attribute [r] include_all_blocks # If set to True, all expired and depleted blocks, as well as active block will be - # returned. + # returned. # # @return [Boolean, nil] optional :include_all_blocks, Orb::Internal::Type::Boolean diff --git a/lib/orb/models/customers/credit_list_params.rb b/lib/orb/models/customers/credit_list_params.rb index a44b39e0..0fc64173 100644 --- a/lib/orb/models/customers/credit_list_params.rb +++ b/lib/orb/models/customers/credit_list_params.rb @@ -17,14 +17,14 @@ class CreditListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true # @!attribute [r] include_all_blocks # If set to True, all expired and depleted blocks, as well as active block will be - # returned. + # returned. # # @return [Boolean, nil] optional :include_all_blocks, Orb::Internal::Type::Boolean 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 cd80ebdc..9ec2ecfe 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 @@ -12,7 +12,7 @@ class LedgerCreateEntryByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute amount # The number of credits to effect. Note that this is required for increment, - # decrement or void operations. + # decrement or void operations. # # @return [Float] required :amount, Float @@ -25,22 +25,22 @@ class LedgerCreateEntryByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute currency # The currency or custom pricing unit to use for this ledger entry. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. # # @return [String, nil] optional :currency, String, nil?: true # @!attribute description # Optional metadata that can be specified when adding ledger results via the API. - # For example, this can be used to note an increment refers to trial credits, or - # for noting corrections as a result of an incident, etc. + # For example, this can be used to note an increment refers to trial credits, or + # for noting corrections as a result of an incident, etc. # # @return [String, nil] optional :description, String, nil?: true # @!attribute effective_date # An ISO 8601 format date that denotes when this credit balance should become - # available for use. + # available for use. # # @return [Time, nil] optional :effective_date, Time, nil?: true @@ -53,9 +53,9 @@ class LedgerCreateEntryByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute invoice_settings # Passing `invoice_settings` automatically generates an invoice for the newly - # added credits. If `invoice_settings` is passed, you must specify - # per_unit_cost_basis, as the calculation of the invoice total is done on that - # basis. + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. # # @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] optional :invoice_settings, @@ -64,23 +64,23 @@ class LedgerCreateEntryByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute per_unit_cost_basis # Can only be specified when entry_type=increment. How much, in the customer's - # currency, a customer paid for a single credit in this block + # currency, a customer paid for a single credit in this block # # @return [String, nil] optional :per_unit_cost_basis, String, nil?: true # @!attribute target_expiry_date # A future date (specified in YYYY-MM-DD format) used for expiration change, - # denoting when credits transferred (as part of a partial block expiration) should - # expire. + # denoting when credits transferred (as part of a partial block expiration) should + # expire. # # @return [Date] required :target_expiry_date, Date @@ -150,15 +150,15 @@ module EntryType class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. # # @return [Boolean] required :auto_collection, Orb::Internal::Type::Boolean # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. # # @return [Integer] required :net_terms, Integer @@ -171,7 +171,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute [r] require_successful_payment # If true, the new credit block will require that the corresponding invoice is - # paid before it can be drawn down from. + # paid before it can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean @@ -182,9 +182,9 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!parse # # Passing `invoice_settings` automatically generates an invoice for the newly - # # added credits. If `invoice_settings` is passed, you must specify - # # per_unit_cost_basis, as the calculation of the invoice total is done on that - # # basis. + # # added credits. If `invoice_settings` is passed, you must specify + # # per_unit_cost_basis, as the calculation of the invoice total is done on that + # # basis. # # # # @param auto_collection [Boolean] # # @param net_terms [Integer] 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 f410de10..a021c658 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 @@ -5,7 +5,7 @@ module Models module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid - # credits within Orb. + # credits within Orb. # # @see Orb::Resources::Customers::Credits::Ledger#create_entry_by_external_id module LedgerCreateEntryByExternalIDResponse @@ -95,9 +95,9 @@ class IncrementLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -267,9 +267,9 @@ class DecrementLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -460,9 +460,9 @@ class ExpirationChangeLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -639,9 +639,9 @@ class CreditBlockExpiryLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -811,9 +811,9 @@ class VoidLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -997,9 +997,9 @@ class VoidInitiatedLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -1190,9 +1190,9 @@ class AmendmentLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] 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 5a2a78d0..098d1631 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_params.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_params.rb @@ -12,7 +12,7 @@ class LedgerCreateEntryParams < Orb::Internal::Type::BaseModel # @!attribute amount # The number of credits to effect. Note that this is required for increment, - # decrement or void operations. + # decrement or void operations. # # @return [Float] required :amount, Float @@ -24,22 +24,22 @@ class LedgerCreateEntryParams < Orb::Internal::Type::BaseModel # @!attribute currency # The currency or custom pricing unit to use for this ledger entry. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. # # @return [String, nil] optional :currency, String, nil?: true # @!attribute description # Optional metadata that can be specified when adding ledger results via the API. - # For example, this can be used to note an increment refers to trial credits, or - # for noting corrections as a result of an incident, etc. + # For example, this can be used to note an increment refers to trial credits, or + # for noting corrections as a result of an incident, etc. # # @return [String, nil] optional :description, String, nil?: true # @!attribute effective_date # An ISO 8601 format date that denotes when this credit balance should become - # available for use. + # available for use. # # @return [Time, nil] optional :effective_date, Time, nil?: true @@ -52,9 +52,9 @@ class LedgerCreateEntryParams < Orb::Internal::Type::BaseModel # @!attribute invoice_settings # Passing `invoice_settings` automatically generates an invoice for the newly - # added credits. If `invoice_settings` is passed, you must specify - # per_unit_cost_basis, as the calculation of the invoice total is done on that - # basis. + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. # # @return [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] optional :invoice_settings, @@ -63,23 +63,23 @@ class LedgerCreateEntryParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute per_unit_cost_basis # Can only be specified when entry_type=increment. How much, in the customer's - # currency, a customer paid for a single credit in this block + # currency, a customer paid for a single credit in this block # # @return [String, nil] optional :per_unit_cost_basis, String, nil?: true # @!attribute target_expiry_date # A future date (specified in YYYY-MM-DD format) used for expiration change, - # denoting when credits transferred (as part of a partial block expiration) should - # expire. + # denoting when credits transferred (as part of a partial block expiration) should + # expire. # # @return [Date] required :target_expiry_date, Date @@ -149,15 +149,15 @@ module EntryType class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. # # @return [Boolean] required :auto_collection, Orb::Internal::Type::Boolean # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. # # @return [Integer] required :net_terms, Integer @@ -170,7 +170,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute [r] require_successful_payment # If true, the new credit block will require that the corresponding invoice is - # paid before it can be drawn down from. + # paid before it can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean @@ -181,9 +181,9 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!parse # # Passing `invoice_settings` automatically generates an invoice for the newly - # # added credits. If `invoice_settings` is passed, you must specify - # # per_unit_cost_basis, as the calculation of the invoice total is done on that - # # basis. + # # added credits. If `invoice_settings` is passed, you must specify + # # per_unit_cost_basis, as the calculation of the invoice total is done on that + # # basis. # # # # @param auto_collection [Boolean] # # @param net_terms [Integer] 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 b46caa67..6ae6f6a4 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_response.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_response.rb @@ -5,7 +5,7 @@ module Models module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid - # credits within Orb. + # credits within Orb. # # @see Orb::Resources::Customers::Credits::Ledger#create_entry module LedgerCreateEntryResponse @@ -94,9 +94,9 @@ class IncrementLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -266,9 +266,9 @@ class DecrementLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -459,9 +459,9 @@ class ExpirationChangeLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -638,9 +638,9 @@ class CreditBlockExpiryLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -810,9 +810,9 @@ class VoidLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -996,9 +996,9 @@ class VoidInitiatedLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -1189,9 +1189,9 @@ class AmendmentLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] diff --git a/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb b/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb index 9c0df743..74320c75 100644 --- a/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb @@ -38,7 +38,7 @@ class LedgerListByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true 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 ef9f6c39..959fa38a 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 @@ -5,7 +5,7 @@ module Models module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid - # credits within Orb. + # credits within Orb. # # @see Orb::Resources::Customers::Credits::Ledger#list_by_external_id module LedgerListByExternalIDResponse @@ -94,9 +94,9 @@ class IncrementLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -266,9 +266,9 @@ class DecrementLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -459,9 +459,9 @@ class ExpirationChangeLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -638,9 +638,9 @@ class CreditBlockExpiryLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -810,9 +810,9 @@ class VoidLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -996,9 +996,9 @@ class VoidInitiatedLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -1189,9 +1189,9 @@ class AmendmentLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] diff --git a/lib/orb/models/customers/credits/ledger_list_params.rb b/lib/orb/models/customers/credits/ledger_list_params.rb index d907de7a..d8da2b77 100644 --- a/lib/orb/models/customers/credits/ledger_list_params.rb +++ b/lib/orb/models/customers/credits/ledger_list_params.rb @@ -38,7 +38,7 @@ class LedgerListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/customers/credits/ledger_list_response.rb b/lib/orb/models/customers/credits/ledger_list_response.rb index e4758fd7..f0779d40 100644 --- a/lib/orb/models/customers/credits/ledger_list_response.rb +++ b/lib/orb/models/customers/credits/ledger_list_response.rb @@ -5,7 +5,7 @@ module Models module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid - # credits within Orb. + # credits within Orb. # # @see Orb::Resources::Customers::Credits::Ledger#list module LedgerListResponse @@ -91,9 +91,9 @@ class IncrementLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -263,9 +263,9 @@ class DecrementLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -456,9 +456,9 @@ class ExpirationChangeLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -635,9 +635,9 @@ class CreditBlockExpiryLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -806,9 +806,9 @@ class VoidLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -992,9 +992,9 @@ class VoidInitiatedLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -1185,9 +1185,9 @@ class AmendmentLedgerEntry < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] 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 af58479b..ba7702ca 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 @@ -18,7 +18,7 @@ class TopUpCreateByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute currency # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. # # @return [String] required :currency, String @@ -38,21 +38,21 @@ class TopUpCreateByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute threshold # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. # # @return [String] required :threshold, String # @!attribute active_from # The date from which the top-up is active. If unspecified, the top-up is active - # immediately. + # immediately. # # @return [Time, nil] optional :active_from, Time, nil?: true # @!attribute expires_after # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. # # @return [Integer, nil] optional :expires_after, Integer, nil?: true @@ -96,15 +96,15 @@ class TopUpCreateByExternalIDParams < Orb::Internal::Type::BaseModel class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. # # @return [Boolean] required :auto_collection, Orb::Internal::Type::Boolean # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. # # @return [Integer] required :net_terms, Integer @@ -117,7 +117,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute [r] require_successful_payment # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean 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 be6c4729..8c786271 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 @@ -19,7 +19,7 @@ class TopUpCreateByExternalIDResponse < Orb::Internal::Type::BaseModel # @!attribute currency # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. # # @return [String] required :currency, String @@ -39,14 +39,14 @@ class TopUpCreateByExternalIDResponse < Orb::Internal::Type::BaseModel # @!attribute threshold # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. # # @return [String] required :threshold, String # @!attribute expires_after # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. # # @return [Integer, nil] optional :expires_after, Integer, nil?: true @@ -89,15 +89,15 @@ class TopUpCreateByExternalIDResponse < Orb::Internal::Type::BaseModel class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. # # @return [Boolean] required :auto_collection, Orb::Internal::Type::Boolean # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. # # @return [Integer] required :net_terms, Integer @@ -110,7 +110,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute [r] require_successful_payment # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean 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 4346192c..47ad256d 100644 --- a/lib/orb/models/customers/credits/top_up_create_params.rb +++ b/lib/orb/models/customers/credits/top_up_create_params.rb @@ -18,7 +18,7 @@ class TopUpCreateParams < Orb::Internal::Type::BaseModel # @!attribute currency # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. # # @return [String] required :currency, String @@ -37,21 +37,21 @@ class TopUpCreateParams < Orb::Internal::Type::BaseModel # @!attribute threshold # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. # # @return [String] required :threshold, String # @!attribute active_from # The date from which the top-up is active. If unspecified, the top-up is active - # immediately. + # immediately. # # @return [Time, nil] optional :active_from, Time, nil?: true # @!attribute expires_after # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. # # @return [Integer, nil] optional :expires_after, Integer, nil?: true @@ -95,15 +95,15 @@ class TopUpCreateParams < Orb::Internal::Type::BaseModel class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. # # @return [Boolean] required :auto_collection, Orb::Internal::Type::Boolean # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. # # @return [Integer] required :net_terms, Integer @@ -116,7 +116,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute [r] require_successful_payment # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean 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 346b16be..c58be05f 100644 --- a/lib/orb/models/customers/credits/top_up_create_response.rb +++ b/lib/orb/models/customers/credits/top_up_create_response.rb @@ -19,7 +19,7 @@ class TopUpCreateResponse < Orb::Internal::Type::BaseModel # @!attribute currency # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. # # @return [String] required :currency, String @@ -38,14 +38,14 @@ class TopUpCreateResponse < Orb::Internal::Type::BaseModel # @!attribute threshold # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. # # @return [String] required :threshold, String # @!attribute expires_after # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. # # @return [Integer, nil] optional :expires_after, Integer, nil?: true @@ -88,15 +88,15 @@ class TopUpCreateResponse < Orb::Internal::Type::BaseModel class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. # # @return [Boolean] required :auto_collection, Orb::Internal::Type::Boolean # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. # # @return [Integer] required :net_terms, Integer @@ -109,7 +109,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute [r] require_successful_payment # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean diff --git a/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb b/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb index cb67da22..dfd6f38b 100644 --- a/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb @@ -12,7 +12,7 @@ class TopUpListByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true 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 120f1469..7f1d9902 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 @@ -19,7 +19,7 @@ class TopUpListByExternalIDResponse < Orb::Internal::Type::BaseModel # @!attribute currency # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. # # @return [String] required :currency, String @@ -39,14 +39,14 @@ class TopUpListByExternalIDResponse < Orb::Internal::Type::BaseModel # @!attribute threshold # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. # # @return [String] required :threshold, String # @!attribute expires_after # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. # # @return [Integer, nil] optional :expires_after, Integer, nil?: true @@ -89,15 +89,15 @@ class TopUpListByExternalIDResponse < Orb::Internal::Type::BaseModel class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. # # @return [Boolean] required :auto_collection, Orb::Internal::Type::Boolean # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. # # @return [Integer] required :net_terms, Integer @@ -110,7 +110,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute [r] require_successful_payment # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean diff --git a/lib/orb/models/customers/credits/top_up_list_params.rb b/lib/orb/models/customers/credits/top_up_list_params.rb index 485449a5..9b0153ab 100644 --- a/lib/orb/models/customers/credits/top_up_list_params.rb +++ b/lib/orb/models/customers/credits/top_up_list_params.rb @@ -12,7 +12,7 @@ class TopUpListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true 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 1f21c2d7..32d868ab 100644 --- a/lib/orb/models/customers/credits/top_up_list_response.rb +++ b/lib/orb/models/customers/credits/top_up_list_response.rb @@ -19,7 +19,7 @@ class TopUpListResponse < Orb::Internal::Type::BaseModel # @!attribute currency # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. # # @return [String] required :currency, String @@ -38,14 +38,14 @@ class TopUpListResponse < Orb::Internal::Type::BaseModel # @!attribute threshold # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. # # @return [String] required :threshold, String # @!attribute expires_after # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. # # @return [Integer, nil] optional :expires_after, Integer, nil?: true @@ -88,15 +88,15 @@ class TopUpListResponse < Orb::Internal::Type::BaseModel class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. # # @return [Boolean] required :auto_collection, Orb::Internal::Type::Boolean # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. # # @return [Integer] required :net_terms, Integer @@ -109,7 +109,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel # @!attribute [r] require_successful_payment # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. # # @return [Boolean, nil] optional :require_successful_payment, Orb::Internal::Type::Boolean diff --git a/lib/orb/models/dimensional_price_group.rb b/lib/orb/models/dimensional_price_group.rb index 448ceb52..6e5c11ef 100644 --- a/lib/orb/models/dimensional_price_group.rb +++ b/lib/orb/models/dimensional_price_group.rb @@ -11,8 +11,8 @@ class DimensionalPriceGroup < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The billable metric associated with this dimensional price group. All prices - # associated with this dimensional price group will be computed using this - # billable metric. + # associated with this dimensional price group will be computed using this + # billable metric. # # @return [String] required :billable_metric_id, String @@ -31,9 +31,9 @@ class DimensionalPriceGroup < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -46,8 +46,8 @@ class DimensionalPriceGroup < Orb::Internal::Type::BaseModel # @!parse # # A dimensional price group is used to partition the result of a billable metric - # # by a set of dimensions. Prices in a price group must specify the parition used - # # to derive their usage. + # # by a set of dimensions. Prices in a price group must specify the parition used + # # to derive their usage. # # # # @param id [String] # # @param billable_metric_id [String] diff --git a/lib/orb/models/dimensional_price_group_create_params.rb b/lib/orb/models/dimensional_price_group_create_params.rb index 8eca14ff..5a5f3c5b 100644 --- a/lib/orb/models/dimensional_price_group_create_params.rb +++ b/lib/orb/models/dimensional_price_group_create_params.rb @@ -31,8 +31,8 @@ class DimensionalPriceGroupCreateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true diff --git a/lib/orb/models/dimensional_price_group_list_params.rb b/lib/orb/models/dimensional_price_group_list_params.rb index cbef9005..e7aa81b3 100644 --- a/lib/orb/models/dimensional_price_group_list_params.rb +++ b/lib/orb/models/dimensional_price_group_list_params.rb @@ -10,7 +10,7 @@ class DimensionalPriceGroupListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/event_ingest_params.rb b/lib/orb/models/event_ingest_params.rb index 2de1f28e..f340cef8 100644 --- a/lib/orb/models/event_ingest_params.rb +++ b/lib/orb/models/event_ingest_params.rb @@ -15,7 +15,7 @@ class EventIngestParams < Orb::Internal::Type::BaseModel # @!attribute backfill_id # If this ingestion request is part of a backfill, this parameter ties the - # ingested events to the backfill + # ingested events to the backfill # # @return [String, nil] optional :backfill_id, String, nil?: true @@ -49,23 +49,23 @@ class Event < Orb::Internal::Type::BaseModel # @!attribute idempotency_key # A unique value, generated by the client, that is used to de-duplicate events. - # Exactly one event with a given idempotency key will be ingested, which allows - # for safe request retries. + # Exactly one event with a given idempotency key will be ingested, which allows + # for safe request retries. # # @return [String] required :idempotency_key, String # @!attribute properties # A dictionary of custom properties. Values in this dictionary must be numeric, - # boolean, or strings. Nested dictionaries are disallowed. + # boolean, or strings. Nested dictionaries are disallowed. # # @return [Object] required :properties, Orb::Internal::Type::Unknown # @!attribute timestamp # An ISO 8601 format date with no timezone offset (i.e. UTC). This should - # represent the time that usage was recorded, and is particularly important to - # attribute usage to a given billing period. + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. # # @return [Time] required :timestamp, Time @@ -78,7 +78,7 @@ class Event < Orb::Internal::Type::BaseModel # @!attribute external_customer_id # An alias for the Orb customer, whose mapping is specified when creating the - # customer + # customer # # @return [String, nil] optional :external_customer_id, String, nil?: true diff --git a/lib/orb/models/event_ingest_response.rb b/lib/orb/models/event_ingest_response.rb index 21cfe88e..2321b477 100644 --- a/lib/orb/models/event_ingest_response.rb +++ b/lib/orb/models/event_ingest_response.rb @@ -6,7 +6,7 @@ module Models class EventIngestResponse < Orb::Internal::Type::BaseModel # @!attribute validation_failed # Contains all failing validation events. In the case of a 200, this array will - # always be empty. This field will always be present. + # always be empty. This field will always be present. # # @return [Array] required :validation_failed, @@ -14,7 +14,7 @@ class EventIngestResponse < Orb::Internal::Type::BaseModel # @!attribute debug # Optional debug information (only present when debug=true is passed to the - # endpoint). Contains ingested and duplicate event idempotency keys. + # endpoint). Contains ingested and duplicate event idempotency keys. # # @return [Orb::Models::EventIngestResponse::Debug, nil] optional :debug, -> { Orb::Models::EventIngestResponse::Debug }, nil?: true @@ -36,7 +36,7 @@ class ValidationFailed < Orb::Internal::Type::BaseModel # @!attribute validation_errors # An array of strings corresponding to validation failures for this - # idempotency_key. + # idempotency_key. # # @return [Array] required :validation_errors, Orb::Internal::Type::ArrayOf[String] @@ -64,7 +64,7 @@ class Debug < Orb::Internal::Type::BaseModel # @!parse # # Optional debug information (only present when debug=true is passed to the - # # endpoint). Contains ingested and duplicate event idempotency keys. + # # endpoint). Contains ingested and duplicate event idempotency keys. # # # # @param duplicate [Array] # # @param ingested [Array] diff --git a/lib/orb/models/event_search_params.rb b/lib/orb/models/event_search_params.rb index a4e84a53..3104eed7 100644 --- a/lib/orb/models/event_search_params.rb +++ b/lib/orb/models/event_search_params.rb @@ -10,23 +10,23 @@ class EventSearchParams < Orb::Internal::Type::BaseModel # @!attribute event_ids # This is an explicit array of IDs to filter by. Note that an event's ID is the - # idempotency_key that was originally used for ingestion, and this only supports - # events that have not been amended. Values in this array will be treated case - # sensitively. + # idempotency_key that was originally used for ingestion, and this only supports + # events that have not been amended. Values in this array will be treated case + # sensitively. # # @return [Array] required :event_ids, Orb::Internal::Type::ArrayOf[String] # @!attribute timeframe_end # The end of the timeframe, exclusive, in which to search events. If not - # specified, the current time is used. + # specified, the current time is used. # # @return [Time, nil] optional :timeframe_end, Time, nil?: true # @!attribute timeframe_start # The start of the timeframe, inclusive, in which to search events. If not - # specified, the one week ago is used. + # specified, the one week ago is used. # # @return [Time, nil] optional :timeframe_start, Time, nil?: true diff --git a/lib/orb/models/event_search_response.rb b/lib/orb/models/event_search_response.rb index c02e6a3c..e4533d95 100644 --- a/lib/orb/models/event_search_response.rb +++ b/lib/orb/models/event_search_response.rb @@ -19,8 +19,8 @@ class EventSearchResponse < Orb::Internal::Type::BaseModel class Data < Orb::Internal::Type::BaseModel # @!attribute id # A unique value, generated by the client, that is used to de-duplicate events. - # Exactly one event with a given idempotency key will be ingested, which allows - # for safe request retries. + # Exactly one event with a given idempotency key will be ingested, which allows + # for safe request retries. # # @return [String] required :id, String @@ -45,30 +45,30 @@ class Data < Orb::Internal::Type::BaseModel # @!attribute external_customer_id # An alias for the Orb customer, whose mapping is specified when creating the - # customer + # customer # # @return [String, nil] required :external_customer_id, String, nil?: true # @!attribute properties # A dictionary of custom properties. Values in this dictionary must be numeric, - # boolean, or strings. Nested dictionaries are disallowed. + # boolean, or strings. Nested dictionaries are disallowed. # # @return [Object] required :properties, Orb::Internal::Type::Unknown # @!attribute timestamp # An ISO 8601 format date with no timezone offset (i.e. UTC). This should - # represent the time that usage was recorded, and is particularly important to - # attribute usage to a given billing period. + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. # # @return [Time] required :timestamp, Time # @!parse # # The [Event](/core-concepts#event) resource represents a usage event that has - # # been created for a customer. Events are the core of Orb's usage-based billing - # # model, and are used to calculate the usage charges for a given billing period. + # # been created for a customer. Events are the core of Orb's usage-based billing + # # model, and are used to calculate the usage charges for a given billing period. # # # # @param id [String] # # @param customer_id [String, nil] diff --git a/lib/orb/models/event_update_params.rb b/lib/orb/models/event_update_params.rb index 52e720ce..5456d632 100644 --- a/lib/orb/models/event_update_params.rb +++ b/lib/orb/models/event_update_params.rb @@ -16,15 +16,15 @@ class EventUpdateParams < Orb::Internal::Type::BaseModel # @!attribute properties # A dictionary of custom properties. Values in this dictionary must be numeric, - # boolean, or strings. Nested dictionaries are disallowed. + # boolean, or strings. Nested dictionaries are disallowed. # # @return [Object] required :properties, Orb::Internal::Type::Unknown # @!attribute timestamp # An ISO 8601 format date with no timezone offset (i.e. UTC). This should - # represent the time that usage was recorded, and is particularly important to - # attribute usage to a given billing period. + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. # # @return [Time] required :timestamp, Time @@ -37,7 +37,7 @@ class EventUpdateParams < Orb::Internal::Type::BaseModel # @!attribute external_customer_id # An alias for the Orb customer, whose mapping is specified when creating the - # customer + # customer # # @return [String, nil] optional :external_customer_id, String, nil?: true diff --git a/lib/orb/models/events/backfill_close_response.rb b/lib/orb/models/events/backfill_close_response.rb index b2f81c1f..ed749215 100644 --- a/lib/orb/models/events/backfill_close_response.rb +++ b/lib/orb/models/events/backfill_close_response.rb @@ -12,7 +12,7 @@ class BackfillCloseResponse < Orb::Internal::Type::BaseModel # @!attribute close_time # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. # # @return [Time, nil] required :close_time, Time, nil?: true @@ -24,7 +24,7 @@ class BackfillCloseResponse < Orb::Internal::Type::BaseModel # @!attribute customer_id # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. # # @return [String, nil] required :customer_id, String, nil?: true @@ -37,8 +37,8 @@ class BackfillCloseResponse < Orb::Internal::Type::BaseModel # @!attribute replace_existing_events # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. # # @return [Boolean] required :replace_existing_events, Orb::Internal::Type::Boolean @@ -67,15 +67,15 @@ class BackfillCloseResponse < Orb::Internal::Type::BaseModel # @!attribute deprecation_filter # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate # # @return [String, nil] optional :deprecation_filter, String, nil?: true # @!parse # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. + # # events in a timeframe. # # # # @param id [String] # # @param close_time [Time, nil] diff --git a/lib/orb/models/events/backfill_create_params.rb b/lib/orb/models/events/backfill_create_params.rb index 0ad4b2b9..1b0b5293 100644 --- a/lib/orb/models/events/backfill_create_params.rb +++ b/lib/orb/models/events/backfill_create_params.rb @@ -11,53 +11,53 @@ class BackfillCreateParams < Orb::Internal::Type::BaseModel # @!attribute timeframe_end # The (exclusive) end of the usage timeframe affected by this backfill. By - # default, Orb allows backfills up to 10 days in duration at a time. Reach out to - # discuss extending this limit and your use case. + # default, Orb allows backfills up to 10 days in duration at a time. Reach out to + # discuss extending this limit and your use case. # # @return [Time] required :timeframe_end, Time # @!attribute timeframe_start # The (inclusive) start of the usage timeframe affected by this backfill. By - # default, Orb allows backfills up to 10 days in duration at a time. Reach out to - # discuss extending this limit and your use case. + # default, Orb allows backfills up to 10 days in duration at a time. Reach out to + # discuss extending this limit and your use case. # # @return [Time] required :timeframe_start, Time # @!attribute close_time # The time at which no more events will be accepted for this backfill. The - # backfill will automatically begin reflecting throughout Orb at the close time. - # If not specified, it will default to 1 day after the creation of the backfill. + # backfill will automatically begin reflecting throughout Orb at the close time. + # If not specified, it will default to 1 day after the creation of the backfill. # # @return [Time, nil] optional :close_time, Time, nil?: true # @!attribute customer_id # The Orb-generated ID of the customer to which this backfill is scoped. Omitting - # this field will scope the backfill to all customers. + # this field will scope the backfill to all customers. # # @return [String, nil] optional :customer_id, String, nil?: true # @!attribute deprecation_filter # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate # # @return [String, nil] optional :deprecation_filter, String, nil?: true # @!attribute external_customer_id # The external customer ID of the customer to which this backfill is scoped. - # Omitting this field will scope the backfill to all customers. + # Omitting this field will scope the backfill to all customers. # # @return [String, nil] optional :external_customer_id, String, nil?: true # @!attribute [r] replace_existing_events # If true, replaces all existing events in the timeframe with the newly ingested - # events. If false, adds the newly ingested events to the existing events. + # events. If false, adds the newly ingested events to the existing events. # # @return [Boolean, nil] optional :replace_existing_events, Orb::Internal::Type::Boolean diff --git a/lib/orb/models/events/backfill_create_response.rb b/lib/orb/models/events/backfill_create_response.rb index 0753c59a..9e3c8132 100644 --- a/lib/orb/models/events/backfill_create_response.rb +++ b/lib/orb/models/events/backfill_create_response.rb @@ -12,7 +12,7 @@ class BackfillCreateResponse < Orb::Internal::Type::BaseModel # @!attribute close_time # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. # # @return [Time, nil] required :close_time, Time, nil?: true @@ -24,7 +24,7 @@ class BackfillCreateResponse < Orb::Internal::Type::BaseModel # @!attribute customer_id # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. # # @return [String, nil] required :customer_id, String, nil?: true @@ -37,8 +37,8 @@ class BackfillCreateResponse < Orb::Internal::Type::BaseModel # @!attribute replace_existing_events # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. # # @return [Boolean] required :replace_existing_events, Orb::Internal::Type::Boolean @@ -67,15 +67,15 @@ class BackfillCreateResponse < Orb::Internal::Type::BaseModel # @!attribute deprecation_filter # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate # # @return [String, nil] optional :deprecation_filter, String, nil?: true # @!parse # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. + # # events in a timeframe. # # # # @param id [String] # # @param close_time [Time, nil] diff --git a/lib/orb/models/events/backfill_fetch_response.rb b/lib/orb/models/events/backfill_fetch_response.rb index 72827fc6..ebb3456a 100644 --- a/lib/orb/models/events/backfill_fetch_response.rb +++ b/lib/orb/models/events/backfill_fetch_response.rb @@ -12,7 +12,7 @@ class BackfillFetchResponse < Orb::Internal::Type::BaseModel # @!attribute close_time # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. # # @return [Time, nil] required :close_time, Time, nil?: true @@ -24,7 +24,7 @@ class BackfillFetchResponse < Orb::Internal::Type::BaseModel # @!attribute customer_id # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. # # @return [String, nil] required :customer_id, String, nil?: true @@ -37,8 +37,8 @@ class BackfillFetchResponse < Orb::Internal::Type::BaseModel # @!attribute replace_existing_events # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. # # @return [Boolean] required :replace_existing_events, Orb::Internal::Type::Boolean @@ -67,15 +67,15 @@ class BackfillFetchResponse < Orb::Internal::Type::BaseModel # @!attribute deprecation_filter # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate # # @return [String, nil] optional :deprecation_filter, String, nil?: true # @!parse # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. + # # events in a timeframe. # # # # @param id [String] # # @param close_time [Time, nil] diff --git a/lib/orb/models/events/backfill_list_params.rb b/lib/orb/models/events/backfill_list_params.rb index a2ffcdc3..ee58760e 100644 --- a/lib/orb/models/events/backfill_list_params.rb +++ b/lib/orb/models/events/backfill_list_params.rb @@ -11,7 +11,7 @@ class BackfillListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/events/backfill_list_response.rb b/lib/orb/models/events/backfill_list_response.rb index 3e8cf84c..c201b98f 100644 --- a/lib/orb/models/events/backfill_list_response.rb +++ b/lib/orb/models/events/backfill_list_response.rb @@ -12,7 +12,7 @@ class BackfillListResponse < Orb::Internal::Type::BaseModel # @!attribute close_time # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. # # @return [Time, nil] required :close_time, Time, nil?: true @@ -24,7 +24,7 @@ class BackfillListResponse < Orb::Internal::Type::BaseModel # @!attribute customer_id # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. # # @return [String, nil] required :customer_id, String, nil?: true @@ -37,8 +37,8 @@ class BackfillListResponse < Orb::Internal::Type::BaseModel # @!attribute replace_existing_events # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. # # @return [Boolean] required :replace_existing_events, Orb::Internal::Type::Boolean @@ -67,15 +67,15 @@ class BackfillListResponse < Orb::Internal::Type::BaseModel # @!attribute deprecation_filter # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate # # @return [String, nil] optional :deprecation_filter, String, nil?: true # @!parse # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. + # # events in a timeframe. # # # # @param id [String] # # @param close_time [Time, nil] diff --git a/lib/orb/models/events/backfill_revert_response.rb b/lib/orb/models/events/backfill_revert_response.rb index 824372e8..f25bbcf6 100644 --- a/lib/orb/models/events/backfill_revert_response.rb +++ b/lib/orb/models/events/backfill_revert_response.rb @@ -12,7 +12,7 @@ class BackfillRevertResponse < Orb::Internal::Type::BaseModel # @!attribute close_time # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. # # @return [Time, nil] required :close_time, Time, nil?: true @@ -24,7 +24,7 @@ class BackfillRevertResponse < Orb::Internal::Type::BaseModel # @!attribute customer_id # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. # # @return [String, nil] required :customer_id, String, nil?: true @@ -37,8 +37,8 @@ class BackfillRevertResponse < Orb::Internal::Type::BaseModel # @!attribute replace_existing_events # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. # # @return [Boolean] required :replace_existing_events, Orb::Internal::Type::Boolean @@ -67,15 +67,15 @@ class BackfillRevertResponse < Orb::Internal::Type::BaseModel # @!attribute deprecation_filter # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate # # @return [String, nil] optional :deprecation_filter, String, nil?: true # @!parse # # A backfill represents an update to historical usage data, adding or replacing - # # events in a timeframe. + # # events in a timeframe. # # # # @param id [String] # # @param close_time [Time, nil] diff --git a/lib/orb/models/events/event_volumes.rb b/lib/orb/models/events/event_volumes.rb index 2e37a08a..b18e7ddf 100644 --- a/lib/orb/models/events/event_volumes.rb +++ b/lib/orb/models/events/event_volumes.rb @@ -36,7 +36,7 @@ class Data < Orb::Internal::Type::BaseModel # @!parse # # An EventVolume contains the event volume ingested in an hourly window. The - # # timestamp used for the aggregation is the `timestamp` datetime field on events. + # # timestamp used for the aggregation is the `timestamp` datetime field on events. # # # # @param count [Integer] # # @param timeframe_end [Time] diff --git a/lib/orb/models/events/volume_list_params.rb b/lib/orb/models/events/volume_list_params.rb index a01735ae..9f9dbe90 100644 --- a/lib/orb/models/events/volume_list_params.rb +++ b/lib/orb/models/events/volume_list_params.rb @@ -11,16 +11,16 @@ class VolumeListParams < Orb::Internal::Type::BaseModel # @!attribute timeframe_start # The start of the timeframe, inclusive, in which to return event volume. All - # datetime values are converted to UTC time. If the specified time isn't - # hour-aligned, the response includes the event volume count for the hour the time - # falls in. + # datetime values are converted to UTC time. If the specified time isn't + # hour-aligned, the response includes the event volume count for the hour the time + # falls in. # # @return [Time] required :timeframe_start, Time # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true @@ -37,9 +37,9 @@ class VolumeListParams < Orb::Internal::Type::BaseModel # @!attribute [r] timeframe_end # The end of the timeframe, exclusive, in which to return event volume. If not - # specified, the current time is used. All datetime values are converted to UTC - # time.If the specified time isn't hour-aligned, the response includes the event - # volumecount for the hour the time falls in. + # specified, the current time is used. All datetime values are converted to UTC + # time.If the specified time isn't hour-aligned, the response includes the event + # volumecount for the hour the time falls in. # # @return [Time, nil] optional :timeframe_end, Time diff --git a/lib/orb/models/invoice.rb b/lib/orb/models/invoice.rb index 46ec131a..fa5ca019 100644 --- a/lib/orb/models/invoice.rb +++ b/lib/orb/models/invoice.rb @@ -11,7 +11,7 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute amount_due # This is the final amount required to be charged to the customer and reflects the - # application of the customer balance to the `total` of the invoice. + # application of the customer balance to the `total` of the invoice. # # @return [String] required :amount_due, String @@ -57,118 +57,118 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute customer_tax_id # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # @return [Orb::Models::Invoice::CustomerTaxID, nil] required :customer_tax_id, -> { Orb::Models::Invoice::CustomerTaxID }, nil?: true # @!attribute discount # This field is deprecated in favor of `discounts`. If a `discounts` list is - # provided, the first discount in the list will be returned. If the list is empty, - # `None` will be returned. + # provided, the first discount in the list will be returned. If the list is empty, + # `None` will be returned. # # @return [Object] required :discount, Orb::Internal::Type::Unknown @@ -180,22 +180,22 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute due_date # When the invoice payment is due. The due date is null if the invoice is not yet - # finalized. + # finalized. # # @return [Time, nil] required :due_date, Time, nil?: true # @!attribute eligible_to_issue_at # If the invoice has a status of `draft`, this will be the time that the invoice - # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is - # true, the invoice will automatically begin issuing at this time. + # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is + # true, the invoice will automatically begin issuing at this time. # # @return [Time, nil] required :eligible_to_issue_at, Time, nil?: true # @!attribute hosted_invoice_url # A URL for the customer-facing invoice portal. This URL expires 30 days after the - # invoice's due date, or 60 days after being re-generated through the UI. + # invoice's due date, or 60 days after being re-generated through the UI. # # @return [String, nil] required :hosted_invoice_url, String, nil?: true @@ -208,8 +208,8 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute invoice_number # Automatically generated invoice number to help track and reconcile invoices. - # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per - # account or customer. + # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per + # account or customer. # # @return [String] required :invoice_number, String @@ -227,14 +227,14 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute issue_failed_at # If the invoice failed to issue, this will be the last time it failed to issue - # (even if it is now in a different state.) + # (even if it is now in a different state.) # # @return [Time, nil] required :issue_failed_at, Time, nil?: true # @!attribute issued_at # If the invoice has been issued, this will be the time it transitioned to - # `issued` (even if it is now in a different state.) + # `issued` (even if it is now in a different state.) # # @return [Time, nil] required :issued_at, Time, nil?: true @@ -263,9 +263,9 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -282,7 +282,7 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute paid_at # If the invoice has a status of `paid`, this gives a timestamp when the invoice - # was paid. + # was paid. # # @return [Time, nil] required :paid_at, Time, nil?: true @@ -295,22 +295,22 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute payment_failed_at # If payment was attempted on this invoice but failed, this will be the time of - # the most recent attempt. + # the most recent attempt. # # @return [Time, nil] required :payment_failed_at, Time, nil?: true # @!attribute payment_started_at # If payment was attempted on this invoice, this will be the start time of the - # most recent attempt. This field is especially useful for delayed-notification - # payment mechanisms (like bank transfers), where payment can take 3 days or more. + # most recent attempt. This field is especially useful for delayed-notification + # payment mechanisms (like bank transfers), where payment can take 3 days or more. # # @return [Time, nil] required :payment_started_at, Time, nil?: true # @!attribute scheduled_issue_at # If the invoice is in draft, this timestamp will reflect when the invoice is - # scheduled to be issued. + # scheduled to be issued. # # @return [Time, nil] required :scheduled_issue_at, Time, nil?: true @@ -338,8 +338,8 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute sync_failed_at # If the invoice failed to sync, this will be the last time an external invoicing - # provider sync was attempted. This field will always be `null` for invoices using - # Orb Invoicing. + # provider sync was attempted. This field will always be `null` for invoices using + # Orb Invoicing. # # @return [Time, nil] required :sync_failed_at, Time, nil?: true @@ -352,24 +352,24 @@ class Invoice < Orb::Internal::Type::BaseModel # @!attribute voided_at # If the invoice has a status of `void`, this gives a timestamp when the invoice - # was voided. + # was voided. # # @return [Time, nil] required :voided_at, Time, nil?: true # @!attribute will_auto_issue # This is true if the invoice will be automatically issued in the future, and - # false otherwise. + # false otherwise. # # @return [Boolean] required :will_auto_issue, Orb::Internal::Type::Boolean # @!parse # # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, - # # representing the request for payment for a single subscription. This includes a - # # set of line items, which correspond to prices in the subscription's plan and can - # # represent fixed recurring fees or usage-based fees. They are generated at the - # # end of a billing period, or as the result of an action, such as a cancellation. + # # representing the request for payment for a single subscription. This includes a + # # set of line items, which correspond to prices in the subscription's plan and can + # # represent fixed recurring fees or usage-based fees. They are generated at the + # # end of a billing period, or as the result of an action, such as a cancellation. # # # # @param id [String] # # @param amount_due [String] @@ -472,8 +472,8 @@ class AutoCollection < Orb::Internal::Type::BaseModel # @!attribute next_attempt_at # If the invoice is scheduled for auto-collection, this field will reflect when - # the next attempt will occur. If dunning has been exhausted, or auto-collection - # is not enabled for this invoice, this field will be `null`. + # the next attempt will occur. If dunning has been exhausted, or auto-collection + # is not enabled for this invoice, this field will be `null`. # # @return [Time, nil] required :next_attempt_at, Time, nil?: true @@ -486,11 +486,11 @@ class AutoCollection < Orb::Internal::Type::BaseModel # @!attribute previously_attempted_at # If Orb has ever attempted payment auto-collection for this invoice, this field - # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, - # this can be used to tell whether the invoice is currently in dunning (that is, - # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or - # if dunning has been exhausted (`previously_attempted_at` is non-null, but - # `next_attempt_time` is null). + # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, + # this can be used to tell whether the invoice is currently in dunning (that is, + # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or + # if dunning has been exhausted (`previously_attempted_at` is non-null, but + # `next_attempt_time` is null). # # @return [Time, nil] required :previously_attempted_at, Time, nil?: true @@ -585,7 +585,7 @@ class CreditNote < Orb::Internal::Type::BaseModel # @!attribute voided_at # If the credit note has a status of `void`, this gives a timestamp when the - # credit note was voided. + # credit note was voided. # # @return [Time, nil] required :voided_at, Time, nil?: true @@ -662,7 +662,7 @@ class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel # @!attribute ending_balance # The new value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. # # @return [String] required :ending_balance, String @@ -674,7 +674,7 @@ class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel # @!attribute starting_balance # The original value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. # # @return [String] required :starting_balance, String @@ -801,110 +801,110 @@ class CustomerTaxID < Orb::Internal::Type::BaseModel # @!parse # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. + # # added to the headers of invoices. # # - # # ### Supported Tax ID Countries and Types + # # ### Supported Tax ID Countries and Types # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # # | Country | Type | Description | + # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # # | Andorra | `ad_nrt` | Andorran NRT Number | + # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # # | Austria | `eu_vat` | European VAT Number | + # # | Bahrain | `bh_vat` | Bahraini VAT Number | + # # | Belgium | `eu_vat` | European VAT Number | + # # | Bolivia | `bo_tin` | Bolivian Tax ID | + # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # # | Brazil | `br_cpf` | Brazilian CPF Number | + # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # # | Bulgaria | `eu_vat` | European VAT Number | + # # | Canada | `ca_bn` | Canadian BN | + # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # # | Chile | `cl_tin` | Chilean TIN | + # # | China | `cn_tin` | Chinese Tax ID | + # # | Colombia | `co_nit` | Colombian NIT Number | + # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # # | Croatia | `eu_vat` | European VAT Number | + # # | Cyprus | `eu_vat` | European VAT Number | + # # | Czech Republic | `eu_vat` | European VAT Number | + # # | Denmark | `eu_vat` | European VAT Number | + # # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # # | Estonia | `eu_vat` | European VAT Number | + # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # # | Finland | `eu_vat` | European VAT Number | + # # | France | `eu_vat` | European VAT Number | + # # | Georgia | `ge_vat` | Georgian VAT | + # # | Germany | `eu_vat` | European VAT Number | + # # | Greece | `eu_vat` | European VAT Number | + # # | Hong Kong | `hk_br` | Hong Kong BR Number | + # # | Hungary | `eu_vat` | European VAT Number | + # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # # | Iceland | `is_vat` | Icelandic VAT | + # # | India | `in_gst` | Indian GST Number | + # # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # # | Ireland | `eu_vat` | European VAT Number | + # # | Israel | `il_vat` | Israel VAT | + # # | Italy | `eu_vat` | European VAT Number | + # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # # | Latvia | `eu_vat` | European VAT Number | + # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # # | Lithuania | `eu_vat` | European VAT Number | + # # | Luxembourg | `eu_vat` | European VAT Number | + # # | Malaysia | `my_frp` | Malaysian FRP Number | + # # | Malaysia | `my_itn` | Malaysian ITN | + # # | Malaysia | `my_sst` | Malaysian SST Number | + # # | Malta | `eu_vat ` | European VAT Number | + # # | Mexico | `mx_rfc` | Mexican RFC Number | + # # | Netherlands | `eu_vat` | European VAT Number | + # # | New Zealand | `nz_gst` | New Zealand GST Number | + # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # # | Norway | `no_vat` | Norwegian VAT Number | + # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # # | Oman | `om_vat` | Omani VAT Number | + # # | Peru | `pe_ruc` | Peruvian RUC Number | + # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # # | Poland | `eu_vat` | European VAT Number | + # # | Portugal | `eu_vat` | European VAT Number | + # # | Romania | `eu_vat` | European VAT Number | + # # | Romania | `ro_tin` | Romanian Tax ID Number | + # # | Russia | `ru_inn` | Russian INN | + # # | Russia | `ru_kpp` | Russian KPP | + # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # # | Serbia | `rs_pib` | Serbian PIB Number | + # # | Singapore | `sg_gst` | Singaporean GST | + # # | Singapore | `sg_uen` | Singaporean UEN | + # # | Slovakia | `eu_vat` | European VAT Number | + # # | Slovenia | `eu_vat` | European VAT Number | + # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # # | South Africa | `za_vat` | South African VAT Number | + # # | South Korea | `kr_brn` | Korean BRN | + # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # # | Spain | `eu_vat` | European VAT Number | + # # | Sweden | `eu_vat` | European VAT Number | + # # | Switzerland | `ch_vat` | Switzerland VAT Number | + # # | Taiwan | `tw_vat` | Taiwanese VAT | + # # | Thailand | `th_vat` | Thai VAT | + # # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # # | Ukraine | `ua_vat` | Ukrainian VAT | + # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # # | United States | `us_ein` | United States EIN | + # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # # # @param country [Symbol, Orb::Models::Invoice::CustomerTaxID::Country] # # @param type [Symbol, Orb::Models::Invoice::CustomerTaxID::Type] @@ -1112,15 +1112,15 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute adjusted_subtotal # The line amount after any adjustments and before overage conversion, credits and - # partial invoicing. + # partial invoicing. # # @return [String] required :adjusted_subtotal, String # @!attribute adjustments # All adjustments applied to the line item in the order they were applied based on - # invoice calculations (ie. usage discounts -> amount discounts -> percentage - # discounts -> minimums -> maximums). + # invoice calculations (ie. usage discounts -> amount discounts -> percentage + # discounts -> minimums -> maximums). # # @return [Array] required :adjustments, @@ -1128,7 +1128,7 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute amount # The final amount for a line item after all adjustments and pre paid credits have - # been applied. + # been applied. # # @return [String] required :amount, String @@ -1158,8 +1158,8 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute grouping # [DEPRECATED] For configured prices that are split by a grouping key, this will - # be populated with the key and a value. The `amount` and `subtotal` will be the - # values for this particular grouping. + # be populated with the key and a value. The `amount` and `subtotal` will be the + # values for this particular grouping. # # @return [String, nil] required :grouping, String, nil?: true @@ -1202,15 +1202,15 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] required :price, union: -> { Orb::Models::Price }, nil?: true @@ -1229,7 +1229,7 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute sub_line_items # For complex pricing structures, the line item can be broken down further in - # `sub_line_items`. + # `sub_line_items`. # # @return [Array] required :sub_line_items, @@ -1243,7 +1243,7 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute tax_amounts # An array of tax rates and their incurred tax amounts. Empty if no tax - # integration is configured. + # integration is configured. # # @return [Array] required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice::LineItem::TaxAmount] } @@ -1351,7 +1351,7 @@ class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -1364,7 +1364,7 @@ class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -1413,7 +1413,7 @@ class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -1426,7 +1426,7 @@ class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -1487,14 +1487,14 @@ class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -1555,7 +1555,7 @@ class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -1568,7 +1568,7 @@ class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -1631,14 +1631,14 @@ class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -1685,7 +1685,7 @@ class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -1713,7 +1713,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -2030,7 +2030,7 @@ class TaxAmount < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -2054,7 +2054,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] diff --git a/lib/orb/models/invoice_create_params.rb b/lib/orb/models/invoice_create_params.rb index 45c54cac..db524a34 100644 --- a/lib/orb/models/invoice_create_params.rb +++ b/lib/orb/models/invoice_create_params.rb @@ -10,14 +10,14 @@ class InvoiceCreateParams < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string. Must be the same as the customer's currency if it - # is set. + # is set. # # @return [String] required :currency, String # @!attribute invoice_date # Optional invoice date to set. Must be in the past, if not set, `invoice_date` is - # set to the current time in the customer's timezone. + # set to the current time in the customer's timezone. # # @return [Time] required :invoice_date, Time @@ -29,16 +29,16 @@ class InvoiceCreateParams < Orb::Internal::Type::BaseModel # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of '0' here represents that the - # invoice is due on issue, whereas a value of 30 represents that the customer has - # 30 days to pay the invoice. + # invoices as the date that they are due. A value of '0' here represents that the + # invoice is due on issue, whereas a value of 30 represents that the customer has + # 30 days to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute customer_id # The id of the `Customer` to create this invoice for. One of `customer_id` and - # `external_customer_id` are required. + # `external_customer_id` are required. # # @return [String, nil] optional :customer_id, String, nil?: true @@ -51,7 +51,7 @@ class InvoiceCreateParams < Orb::Internal::Type::BaseModel # @!attribute external_customer_id # The `external_customer_id` of the `Customer` to create this invoice for. One of - # `customer_id` and `external_customer_id` are required. + # `customer_id` and `external_customer_id` are required. # # @return [String, nil] optional :external_customer_id, String, nil?: true @@ -64,15 +64,15 @@ class InvoiceCreateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute [r] will_auto_issue # When true, this invoice will automatically be issued upon creation. When false, - # the resulting invoice will require manual review to issue. Defaulted to false. + # the resulting invoice will require manual review to issue. Defaulted to false. # # @return [Boolean, nil] optional :will_auto_issue, Orb::Internal::Type::Boolean diff --git a/lib/orb/models/invoice_fetch_upcoming_response.rb b/lib/orb/models/invoice_fetch_upcoming_response.rb index ba4ece06..26181e50 100644 --- a/lib/orb/models/invoice_fetch_upcoming_response.rb +++ b/lib/orb/models/invoice_fetch_upcoming_response.rb @@ -11,7 +11,7 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @!attribute amount_due # This is the final amount required to be charged to the customer and reflects the - # application of the customer balance to the `total` of the invoice. + # application of the customer balance to the `total` of the invoice. # # @return [String] required :amount_due, String @@ -58,118 +58,118 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @!attribute customer_tax_id # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # @return [Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, nil] required :customer_tax_id, -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID }, nil?: true # @!attribute discount # This field is deprecated in favor of `discounts`. If a `discounts` list is - # provided, the first discount in the list will be returned. If the list is empty, - # `None` will be returned. + # provided, the first discount in the list will be returned. If the list is empty, + # `None` will be returned. # # @return [Object] required :discount, Orb::Internal::Type::Unknown @@ -181,30 +181,30 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @!attribute due_date # When the invoice payment is due. The due date is null if the invoice is not yet - # finalized. + # finalized. # # @return [Time, nil] required :due_date, Time, nil?: true # @!attribute eligible_to_issue_at # If the invoice has a status of `draft`, this will be the time that the invoice - # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is - # true, the invoice will automatically begin issuing at this time. + # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is + # true, the invoice will automatically begin issuing at this time. # # @return [Time, nil] required :eligible_to_issue_at, Time, nil?: true # @!attribute hosted_invoice_url # A URL for the customer-facing invoice portal. This URL expires 30 days after the - # invoice's due date, or 60 days after being re-generated through the UI. + # invoice's due date, or 60 days after being re-generated through the UI. # # @return [String, nil] required :hosted_invoice_url, String, nil?: true # @!attribute invoice_number # Automatically generated invoice number to help track and reconcile invoices. - # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per - # account or customer. + # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per + # account or customer. # # @return [String] required :invoice_number, String @@ -222,14 +222,14 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @!attribute issue_failed_at # If the invoice failed to issue, this will be the last time it failed to issue - # (even if it is now in a different state.) + # (even if it is now in a different state.) # # @return [Time, nil] required :issue_failed_at, Time, nil?: true # @!attribute issued_at # If the invoice has been issued, this will be the time it transitioned to - # `issued` (even if it is now in a different state.) + # `issued` (even if it is now in a different state.) # # @return [Time, nil] required :issued_at, Time, nil?: true @@ -259,9 +259,9 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -278,7 +278,7 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @!attribute paid_at # If the invoice has a status of `paid`, this gives a timestamp when the invoice - # was paid. + # was paid. # # @return [Time, nil] required :paid_at, Time, nil?: true @@ -292,22 +292,22 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @!attribute payment_failed_at # If payment was attempted on this invoice but failed, this will be the time of - # the most recent attempt. + # the most recent attempt. # # @return [Time, nil] required :payment_failed_at, Time, nil?: true # @!attribute payment_started_at # If payment was attempted on this invoice, this will be the start time of the - # most recent attempt. This field is especially useful for delayed-notification - # payment mechanisms (like bank transfers), where payment can take 3 days or more. + # most recent attempt. This field is especially useful for delayed-notification + # payment mechanisms (like bank transfers), where payment can take 3 days or more. # # @return [Time, nil] required :payment_started_at, Time, nil?: true # @!attribute scheduled_issue_at # If the invoice is in draft, this timestamp will reflect when the invoice is - # scheduled to be issued. + # scheduled to be issued. # # @return [Time, nil] required :scheduled_issue_at, Time, nil?: true @@ -335,8 +335,8 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @!attribute sync_failed_at # If the invoice failed to sync, this will be the last time an external invoicing - # provider sync was attempted. This field will always be `null` for invoices using - # Orb Invoicing. + # provider sync was attempted. This field will always be `null` for invoices using + # Orb Invoicing. # # @return [Time, nil] required :sync_failed_at, Time, nil?: true @@ -355,14 +355,14 @@ class InvoiceFetchUpcomingResponse < Orb::Internal::Type::BaseModel # @!attribute voided_at # If the invoice has a status of `void`, this gives a timestamp when the invoice - # was voided. + # was voided. # # @return [Time, nil] required :voided_at, Time, nil?: true # @!attribute will_auto_issue # This is true if the invoice will be automatically issued in the future, and - # false otherwise. + # false otherwise. # # @return [Boolean] required :will_auto_issue, Orb::Internal::Type::Boolean @@ -469,8 +469,8 @@ class AutoCollection < Orb::Internal::Type::BaseModel # @!attribute next_attempt_at # If the invoice is scheduled for auto-collection, this field will reflect when - # the next attempt will occur. If dunning has been exhausted, or auto-collection - # is not enabled for this invoice, this field will be `null`. + # the next attempt will occur. If dunning has been exhausted, or auto-collection + # is not enabled for this invoice, this field will be `null`. # # @return [Time, nil] required :next_attempt_at, Time, nil?: true @@ -483,11 +483,11 @@ class AutoCollection < Orb::Internal::Type::BaseModel # @!attribute previously_attempted_at # If Orb has ever attempted payment auto-collection for this invoice, this field - # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, - # this can be used to tell whether the invoice is currently in dunning (that is, - # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or - # if dunning has been exhausted (`previously_attempted_at` is non-null, but - # `next_attempt_time` is null). + # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, + # this can be used to tell whether the invoice is currently in dunning (that is, + # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or + # if dunning has been exhausted (`previously_attempted_at` is non-null, but + # `next_attempt_time` is null). # # @return [Time, nil] required :previously_attempted_at, Time, nil?: true @@ -582,7 +582,7 @@ class CreditNote < Orb::Internal::Type::BaseModel # @!attribute voided_at # If the credit note has a status of `void`, this gives a timestamp when the - # credit note was voided. + # credit note was voided. # # @return [Time, nil] required :voided_at, Time, nil?: true @@ -662,7 +662,7 @@ class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel # @!attribute ending_balance # The new value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. # # @return [String] required :ending_balance, String @@ -676,7 +676,7 @@ class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel # @!attribute starting_balance # The original value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. # # @return [String] required :starting_balance, String @@ -803,110 +803,110 @@ class CustomerTaxID < Orb::Internal::Type::BaseModel # @!parse # # Tax IDs are commonly required to be displayed on customer invoices, which are - # # added to the headers of invoices. + # # added to the headers of invoices. # # - # # ### Supported Tax ID Countries and Types + # # ### Supported Tax ID Countries and Types # # - # # | Country | Type | Description | - # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # # | Andorra | `ad_nrt` | Andorran NRT Number | - # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # # | Austria | `eu_vat` | European VAT Number | - # # | Bahrain | `bh_vat` | Bahraini VAT Number | - # # | Belgium | `eu_vat` | European VAT Number | - # # | Bolivia | `bo_tin` | Bolivian Tax ID | - # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # # | Brazil | `br_cpf` | Brazilian CPF Number | - # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # # | Bulgaria | `eu_vat` | European VAT Number | - # # | Canada | `ca_bn` | Canadian BN | - # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # # | Chile | `cl_tin` | Chilean TIN | - # # | China | `cn_tin` | Chinese Tax ID | - # # | Colombia | `co_nit` | Colombian NIT Number | - # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # # | Croatia | `eu_vat` | European VAT Number | - # # | Cyprus | `eu_vat` | European VAT Number | - # # | Czech Republic | `eu_vat` | European VAT Number | - # # | Denmark | `eu_vat` | European VAT Number | - # # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # # | Estonia | `eu_vat` | European VAT Number | - # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # # | Finland | `eu_vat` | European VAT Number | - # # | France | `eu_vat` | European VAT Number | - # # | Georgia | `ge_vat` | Georgian VAT | - # # | Germany | `eu_vat` | European VAT Number | - # # | Greece | `eu_vat` | European VAT Number | - # # | Hong Kong | `hk_br` | Hong Kong BR Number | - # # | Hungary | `eu_vat` | European VAT Number | - # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # # | Iceland | `is_vat` | Icelandic VAT | - # # | India | `in_gst` | Indian GST Number | - # # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # # | Ireland | `eu_vat` | European VAT Number | - # # | Israel | `il_vat` | Israel VAT | - # # | Italy | `eu_vat` | European VAT Number | - # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # # | Latvia | `eu_vat` | European VAT Number | - # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # # | Lithuania | `eu_vat` | European VAT Number | - # # | Luxembourg | `eu_vat` | European VAT Number | - # # | Malaysia | `my_frp` | Malaysian FRP Number | - # # | Malaysia | `my_itn` | Malaysian ITN | - # # | Malaysia | `my_sst` | Malaysian SST Number | - # # | Malta | `eu_vat ` | European VAT Number | - # # | Mexico | `mx_rfc` | Mexican RFC Number | - # # | Netherlands | `eu_vat` | European VAT Number | - # # | New Zealand | `nz_gst` | New Zealand GST Number | - # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # # | Norway | `no_vat` | Norwegian VAT Number | - # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # # | Oman | `om_vat` | Omani VAT Number | - # # | Peru | `pe_ruc` | Peruvian RUC Number | - # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # # | Poland | `eu_vat` | European VAT Number | - # # | Portugal | `eu_vat` | European VAT Number | - # # | Romania | `eu_vat` | European VAT Number | - # # | Romania | `ro_tin` | Romanian Tax ID Number | - # # | Russia | `ru_inn` | Russian INN | - # # | Russia | `ru_kpp` | Russian KPP | - # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # # | Serbia | `rs_pib` | Serbian PIB Number | - # # | Singapore | `sg_gst` | Singaporean GST | - # # | Singapore | `sg_uen` | Singaporean UEN | - # # | Slovakia | `eu_vat` | European VAT Number | - # # | Slovenia | `eu_vat` | European VAT Number | - # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # # | South Africa | `za_vat` | South African VAT Number | - # # | South Korea | `kr_brn` | Korean BRN | - # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # # | Spain | `eu_vat` | European VAT Number | - # # | Sweden | `eu_vat` | European VAT Number | - # # | Switzerland | `ch_vat` | Switzerland VAT Number | - # # | Taiwan | `tw_vat` | Taiwanese VAT | - # # | Thailand | `th_vat` | Thai VAT | - # # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # # | Ukraine | `ua_vat` | Ukrainian VAT | - # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # # | United States | `us_ein` | United States EIN | - # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # # | Country | Type | Description | + # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # # | Andorra | `ad_nrt` | Andorran NRT Number | + # # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # # | Austria | `eu_vat` | European VAT Number | + # # | Bahrain | `bh_vat` | Bahraini VAT Number | + # # | Belgium | `eu_vat` | European VAT Number | + # # | Bolivia | `bo_tin` | Bolivian Tax ID | + # # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # # | Brazil | `br_cpf` | Brazilian CPF Number | + # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # # | Bulgaria | `eu_vat` | European VAT Number | + # # | Canada | `ca_bn` | Canadian BN | + # # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # # | Chile | `cl_tin` | Chilean TIN | + # # | China | `cn_tin` | Chinese Tax ID | + # # | Colombia | `co_nit` | Colombian NIT Number | + # # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # # | Croatia | `eu_vat` | European VAT Number | + # # | Cyprus | `eu_vat` | European VAT Number | + # # | Czech Republic | `eu_vat` | European VAT Number | + # # | Denmark | `eu_vat` | European VAT Number | + # # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # # | Estonia | `eu_vat` | European VAT Number | + # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # # | Finland | `eu_vat` | European VAT Number | + # # | France | `eu_vat` | European VAT Number | + # # | Georgia | `ge_vat` | Georgian VAT | + # # | Germany | `eu_vat` | European VAT Number | + # # | Greece | `eu_vat` | European VAT Number | + # # | Hong Kong | `hk_br` | Hong Kong BR Number | + # # | Hungary | `eu_vat` | European VAT Number | + # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # # | Iceland | `is_vat` | Icelandic VAT | + # # | India | `in_gst` | Indian GST Number | + # # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # # | Ireland | `eu_vat` | European VAT Number | + # # | Israel | `il_vat` | Israel VAT | + # # | Italy | `eu_vat` | European VAT Number | + # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # # | Latvia | `eu_vat` | European VAT Number | + # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # # | Lithuania | `eu_vat` | European VAT Number | + # # | Luxembourg | `eu_vat` | European VAT Number | + # # | Malaysia | `my_frp` | Malaysian FRP Number | + # # | Malaysia | `my_itn` | Malaysian ITN | + # # | Malaysia | `my_sst` | Malaysian SST Number | + # # | Malta | `eu_vat ` | European VAT Number | + # # | Mexico | `mx_rfc` | Mexican RFC Number | + # # | Netherlands | `eu_vat` | European VAT Number | + # # | New Zealand | `nz_gst` | New Zealand GST Number | + # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # # | Norway | `no_vat` | Norwegian VAT Number | + # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # # | Oman | `om_vat` | Omani VAT Number | + # # | Peru | `pe_ruc` | Peruvian RUC Number | + # # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # # | Poland | `eu_vat` | European VAT Number | + # # | Portugal | `eu_vat` | European VAT Number | + # # | Romania | `eu_vat` | European VAT Number | + # # | Romania | `ro_tin` | Romanian Tax ID Number | + # # | Russia | `ru_inn` | Russian INN | + # # | Russia | `ru_kpp` | Russian KPP | + # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # # | Serbia | `rs_pib` | Serbian PIB Number | + # # | Singapore | `sg_gst` | Singaporean GST | + # # | Singapore | `sg_uen` | Singaporean UEN | + # # | Slovakia | `eu_vat` | European VAT Number | + # # | Slovenia | `eu_vat` | European VAT Number | + # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # # | South Africa | `za_vat` | South African VAT Number | + # # | South Korea | `kr_brn` | Korean BRN | + # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # # | Spain | `eu_vat` | European VAT Number | + # # | Sweden | `eu_vat` | European VAT Number | + # # | Switzerland | `ch_vat` | Switzerland VAT Number | + # # | Taiwan | `tw_vat` | Taiwanese VAT | + # # | Thailand | `th_vat` | Thai VAT | + # # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # # | Ukraine | `ua_vat` | Ukrainian VAT | + # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # # | United States | `us_ein` | United States EIN | + # # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | # # # # @param country [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country] # # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type] @@ -1114,15 +1114,15 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute adjusted_subtotal # The line amount after any adjustments and before overage conversion, credits and - # partial invoicing. + # partial invoicing. # # @return [String] required :adjusted_subtotal, String # @!attribute adjustments # All adjustments applied to the line item in the order they were applied based on - # invoice calculations (ie. usage discounts -> amount discounts -> percentage - # discounts -> minimums -> maximums). + # invoice calculations (ie. usage discounts -> amount discounts -> percentage + # discounts -> minimums -> maximums). # # @return [Array] required :adjustments, @@ -1130,7 +1130,7 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute amount # The final amount for a line item after all adjustments and pre paid credits have - # been applied. + # been applied. # # @return [String] required :amount, String @@ -1160,8 +1160,8 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute grouping # [DEPRECATED] For configured prices that are split by a grouping key, this will - # be populated with the key and a value. The `amount` and `subtotal` will be the - # values for this particular grouping. + # be populated with the key and a value. The `amount` and `subtotal` will be the + # values for this particular grouping. # # @return [String, nil] required :grouping, String, nil?: true @@ -1204,15 +1204,15 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] required :price, union: -> { Orb::Models::Price }, nil?: true @@ -1231,7 +1231,7 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute sub_line_items # For complex pricing structures, the line item can be broken down further in - # `sub_line_items`. + # `sub_line_items`. # # @return [Array] required :sub_line_items, @@ -1245,7 +1245,7 @@ class LineItem < Orb::Internal::Type::BaseModel # @!attribute tax_amounts # An array of tax rates and their incurred tax amounts. Empty if no tax - # integration is configured. + # integration is configured. # # @return [Array] required :tax_amounts, @@ -1356,7 +1356,7 @@ class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -1369,7 +1369,7 @@ class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -1418,7 +1418,7 @@ class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -1431,7 +1431,7 @@ class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -1492,14 +1492,14 @@ class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -1560,7 +1560,7 @@ class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -1573,7 +1573,7 @@ class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -1636,14 +1636,14 @@ class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -1690,7 +1690,7 @@ class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -1718,7 +1718,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -2038,7 +2038,7 @@ class TaxAmount < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -2062,7 +2062,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] diff --git a/lib/orb/models/invoice_issue_params.rb b/lib/orb/models/invoice_issue_params.rb index 51bab883..662fd07b 100644 --- a/lib/orb/models/invoice_issue_params.rb +++ b/lib/orb/models/invoice_issue_params.rb @@ -10,10 +10,10 @@ class InvoiceIssueParams < Orb::Internal::Type::BaseModel # @!attribute [r] synchronous # If true, the invoice will be issued synchronously. If false, the invoice will be - # issued asynchronously. The synchronous option is only available for invoices - # that have no usage fees. If the invoice is configured to sync to an external - # provider, a successful response from this endpoint guarantees the invoice is - # present in the provider. + # issued asynchronously. The synchronous option is only available for invoices + # that have no usage fees. If the invoice is configured to sync to an external + # provider, a successful response from this endpoint guarantees the invoice is + # present in the provider. # # @return [Boolean, nil] optional :synchronous, Orb::Internal::Type::Boolean diff --git a/lib/orb/models/invoice_line_item_create_params.rb b/lib/orb/models/invoice_line_item_create_params.rb index 9c0403e3..c15335fe 100644 --- a/lib/orb/models/invoice_line_item_create_params.rb +++ b/lib/orb/models/invoice_line_item_create_params.rb @@ -28,7 +28,7 @@ class InvoiceLineItemCreateParams < Orb::Internal::Type::BaseModel # @!attribute name # The item name associated with this line item. If an item with the same name - # exists in Orb, that item will be associated with the line item. + # exists in Orb, that item will be associated with the line item. # # @return [String] required :name, String diff --git a/lib/orb/models/invoice_line_item_create_response.rb b/lib/orb/models/invoice_line_item_create_response.rb index 6d74d34e..cfeef37d 100644 --- a/lib/orb/models/invoice_line_item_create_response.rb +++ b/lib/orb/models/invoice_line_item_create_response.rb @@ -12,15 +12,15 @@ class InvoiceLineItemCreateResponse < Orb::Internal::Type::BaseModel # @!attribute adjusted_subtotal # The line amount after any adjustments and before overage conversion, credits and - # partial invoicing. + # partial invoicing. # # @return [String] required :adjusted_subtotal, String # @!attribute adjustments # All adjustments applied to the line item in the order they were applied based on - # invoice calculations (ie. usage discounts -> amount discounts -> percentage - # discounts -> minimums -> maximums). + # invoice calculations (ie. usage discounts -> amount discounts -> percentage + # discounts -> minimums -> maximums). # # @return [Array] required :adjustments, @@ -28,7 +28,7 @@ class InvoiceLineItemCreateResponse < Orb::Internal::Type::BaseModel # @!attribute amount # The final amount for a line item after all adjustments and pre paid credits have - # been applied. + # been applied. # # @return [String] required :amount, String @@ -58,8 +58,8 @@ class InvoiceLineItemCreateResponse < Orb::Internal::Type::BaseModel # @!attribute grouping # [DEPRECATED] For configured prices that are split by a grouping key, this will - # be populated with the key and a value. The `amount` and `subtotal` will be the - # values for this particular grouping. + # be populated with the key and a value. The `amount` and `subtotal` will be the + # values for this particular grouping. # # @return [String, nil] required :grouping, String, nil?: true @@ -102,15 +102,15 @@ class InvoiceLineItemCreateResponse < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil] required :price, union: -> { Orb::Models::Price }, nil?: true @@ -129,7 +129,7 @@ class InvoiceLineItemCreateResponse < Orb::Internal::Type::BaseModel # @!attribute sub_line_items # For complex pricing structures, the line item can be broken down further in - # `sub_line_items`. + # `sub_line_items`. # # @return [Array] required :sub_line_items, @@ -143,7 +143,7 @@ class InvoiceLineItemCreateResponse < Orb::Internal::Type::BaseModel # @!attribute tax_amounts # An array of tax rates and their incurred tax amounts. Empty if no tax - # integration is configured. + # integration is configured. # # @return [Array] required :tax_amounts, @@ -252,7 +252,7 @@ class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -265,7 +265,7 @@ class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -314,7 +314,7 @@ class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -327,7 +327,7 @@ class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -388,14 +388,14 @@ class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -456,7 +456,7 @@ class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -469,7 +469,7 @@ class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -532,14 +532,14 @@ class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -586,7 +586,7 @@ class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -614,7 +614,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] diff --git a/lib/orb/models/invoice_list_params.rb b/lib/orb/models/invoice_list_params.rb index b6f7099f..ef15e63d 100644 --- a/lib/orb/models/invoice_list_params.rb +++ b/lib/orb/models/invoice_list_params.rb @@ -25,7 +25,7 @@ class InvoiceListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true @@ -47,9 +47,9 @@ class InvoiceListParams < Orb::Internal::Type::BaseModel # @!attribute due_date_window # Filters invoices by their due dates within a specific time range in the past. - # Specify the range as a number followed by 'd' (days) or 'm' (months). For - # example, '7d' filters invoices due in the last 7 days, and '2m' filters those - # due in the last 2 months. + # Specify the range as a number followed by 'd' (days) or 'm' (months). For + # example, '7d' filters invoices due in the last 7 days, and '2m' filters those + # due in the last 2 months. # # @return [String, nil] optional :due_date_window, String, nil?: true diff --git a/lib/orb/models/invoice_update_params.rb b/lib/orb/models/invoice_update_params.rb index 69d7712a..cb0a0081 100644 --- a/lib/orb/models/invoice_update_params.rb +++ b/lib/orb/models/invoice_update_params.rb @@ -10,8 +10,8 @@ class InvoiceUpdateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true diff --git a/lib/orb/models/item.rb b/lib/orb/models/item.rb index 835b74c6..0b54b210 100644 --- a/lib/orb/models/item.rb +++ b/lib/orb/models/item.rb @@ -26,8 +26,8 @@ class Item < Orb::Internal::Type::BaseModel # @!parse # # The Item resource represents a sellable product or good. Items are associated - # # with all line items, billable metrics, and prices and are used for defining - # # external sync behavior for invoices and tax calculation purposes. + # # with all line items, billable metrics, and prices and are used for defining + # # external sync behavior for invoices and tax calculation purposes. # # # # @param id [String] # # @param created_at [Time] diff --git a/lib/orb/models/item_list_params.rb b/lib/orb/models/item_list_params.rb index 2efd1937..bdbfb38d 100644 --- a/lib/orb/models/item_list_params.rb +++ b/lib/orb/models/item_list_params.rb @@ -10,7 +10,7 @@ class ItemListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/metric_create_params.rb b/lib/orb/models/metric_create_params.rb index 4f46edea..201f4506 100644 --- a/lib/orb/models/metric_create_params.rb +++ b/lib/orb/models/metric_create_params.rb @@ -34,8 +34,8 @@ class MetricCreateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true diff --git a/lib/orb/models/metric_list_params.rb b/lib/orb/models/metric_list_params.rb index 9bef2221..50f7e8a1 100644 --- a/lib/orb/models/metric_list_params.rb +++ b/lib/orb/models/metric_list_params.rb @@ -30,7 +30,7 @@ class MetricListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/metric_update_params.rb b/lib/orb/models/metric_update_params.rb index f6a34a0b..36b97e44 100644 --- a/lib/orb/models/metric_update_params.rb +++ b/lib/orb/models/metric_update_params.rb @@ -10,8 +10,8 @@ class MetricUpdateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true diff --git a/lib/orb/models/percentage_discount.rb b/lib/orb/models/percentage_discount.rb index bcafe94e..a56abe13 100644 --- a/lib/orb/models/percentage_discount.rb +++ b/lib/orb/models/percentage_discount.rb @@ -5,7 +5,7 @@ module Models class PercentageDiscount < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this discount applies to. For plan/plan phase discounts, - # this can be a subset of prices. + # this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -17,7 +17,7 @@ class PercentageDiscount < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float diff --git a/lib/orb/models/plan.rb b/lib/orb/models/plan.rb index ca979da7..0f943327 100644 --- a/lib/orb/models/plan.rb +++ b/lib/orb/models/plan.rb @@ -11,7 +11,7 @@ class Plan < Orb::Internal::Type::BaseModel # @!attribute adjustments # Adjustments for this plan. If the plan has phases, this includes adjustments - # across all phases of the plan. + # across all phases of the plan. # # @return [Array] required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Plan::Adjustment] } @@ -23,7 +23,7 @@ class Plan < Orb::Internal::Type::BaseModel # @!attribute base_plan_id # The parent plan id if the given plan was created by overriding one or more of - # the parent's prices + # the parent's prices # # @return [String, nil] required :base_plan_id, String, nil?: true @@ -35,14 +35,14 @@ class Plan < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's - # prices. + # prices. # # @return [String] required :currency, String # @!attribute default_invoice_memo # The default memo text on the invoices corresponding to subscriptions on this - # plan. Note that each subscription may configure its own memo. + # plan. Note that each subscription may configure its own memo. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -59,15 +59,15 @@ class Plan < Orb::Internal::Type::BaseModel # @!attribute external_plan_id # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. # # @return [String, nil] required :external_plan_id, String, nil?: true # @!attribute invoicing_currency # An ISO 4217 currency string for which this plan is billed in. Matches `currency` - # unless `currency` is a custom pricing unit. + # unless `currency` is a custom pricing unit. # # @return [String] required :invoicing_currency, String @@ -84,9 +84,9 @@ class Plan < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -108,10 +108,10 @@ class Plan < Orb::Internal::Type::BaseModel # @!attribute net_terms # Determines the difference between the invoice issue date and the due date. A - # value of "0" here signifies that invoices are due on issue, whereas a value of - # "30" means that the customer has a month to pay the invoice before its overdue. - # Note that individual subscriptions or invoices may set a different net terms - # configuration. + # value of "0" here signifies that invoices are due on issue, whereas a value of + # "30" means that the customer has a month to pay the invoice before its overdue. + # Note that individual subscriptions or invoices may set a different net terms + # configuration. # # @return [Integer, nil] required :net_terms, Integer, nil?: true @@ -123,7 +123,7 @@ class Plan < Orb::Internal::Type::BaseModel # @!attribute prices # Prices for this plan. If the plan has phases, this includes prices across all - # phases of the plan. + # phases of the plan. # # @return [Array] required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Price] } @@ -150,9 +150,9 @@ class Plan < Orb::Internal::Type::BaseModel # @!parse # # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # # subscribed to by a customer. Plans define the billing behavior of the - # # subscription. You can see more about how to configure prices in the - # # [Price resource](/reference/price). + # # subscribed to by a customer. Plans define the billing behavior of the + # # subscription. You can see more about how to configure prices in the + # # [Price resource](/reference/price). # # # # @param id [String] # # @param adjustments [Array] @@ -245,7 +245,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -264,7 +264,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -307,7 +307,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -320,7 +320,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -381,14 +381,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -449,7 +449,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -462,7 +462,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -525,14 +525,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -588,8 +588,8 @@ class BasePlan < Orb::Internal::Type::BaseModel # @!attribute external_plan_id # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. # # @return [String, nil] required :external_plan_id, String, nil?: true @@ -613,7 +613,7 @@ class BasePlan < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -637,7 +637,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -675,7 +675,7 @@ class PlanPhase < Orb::Internal::Type::BaseModel # @!attribute duration # How many terms of length `duration_unit` this phase is active for. If null, this - # phase is evergreen and active indefinitely + # phase is evergreen and active indefinitely # # @return [Integer, nil] required :duration, Integer, nil?: true @@ -769,7 +769,7 @@ module DurationUnit class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -793,7 +793,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] diff --git a/lib/orb/models/plan_create_params.rb b/lib/orb/models/plan_create_params.rb index 7f033571..99d40d8e 100644 --- a/lib/orb/models/plan_create_params.rb +++ b/lib/orb/models/plan_create_params.rb @@ -10,7 +10,7 @@ class PlanCreateParams < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string for invoices generated by subscriptions on this - # plan. + # plan. # # @return [String] required :currency, String @@ -22,7 +22,7 @@ class PlanCreateParams < Orb::Internal::Type::BaseModel # @!attribute prices # Prices for this plan. If the plan has phases, this includes prices across all - # phases of the plan. + # phases of the plan. # # @return [Array] required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::PlanCreateParams::Price] } @@ -40,23 +40,23 @@ class PlanCreateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. # # @return [Integer, nil] optional :net_terms, Integer, nil?: true # @!attribute [r] status # The status of the plan to create (either active or draft). If not specified, - # this defaults to active. + # this defaults to active. # # @return [Symbol, Orb::Models::PlanCreateParams::Status, nil] optional :status, enum: -> { Orb::Models::PlanCreateParams::Status } @@ -189,21 +189,21 @@ class NewPlanUnitPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -218,7 +218,7 @@ class NewPlanUnitPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -231,7 +231,7 @@ class NewPlanUnitPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -244,7 +244,7 @@ class NewPlanUnitPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -253,8 +253,8 @@ class NewPlanUnitPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -352,7 +352,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit] @@ -395,7 +395,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit] @@ -453,21 +453,21 @@ class NewPlanPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -482,7 +482,7 @@ class NewPlanPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -495,7 +495,7 @@ class NewPlanPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -508,7 +508,7 @@ class NewPlanPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -517,8 +517,8 @@ class NewPlanPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -593,7 +593,7 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @!attribute package_size # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating # # @return [Integer] required :package_size, Integer @@ -624,7 +624,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -667,7 +667,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -725,21 +725,21 @@ class NewPlanMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -754,7 +754,7 @@ class NewPlanMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -767,7 +767,7 @@ class NewPlanMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -780,7 +780,7 @@ class NewPlanMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -789,8 +789,8 @@ class NewPlanMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -888,8 +888,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -927,7 +927,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit] @@ -970,7 +970,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1028,21 +1028,21 @@ class NewPlanTieredPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1057,7 +1057,7 @@ class NewPlanTieredPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1070,7 +1070,7 @@ class NewPlanTieredPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1083,7 +1083,7 @@ class NewPlanTieredPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1092,8 +1092,8 @@ class NewPlanTieredPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -1221,7 +1221,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit] @@ -1264,7 +1264,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1323,21 +1323,21 @@ class NewPlanTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1352,7 +1352,7 @@ class NewPlanTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1365,7 +1365,7 @@ class NewPlanTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1378,7 +1378,7 @@ class NewPlanTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1387,8 +1387,8 @@ class NewPlanTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -1457,7 +1457,7 @@ module Cadence class TieredBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers # # @return [Array] required :tiers, @@ -1524,7 +1524,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -1567,7 +1567,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1625,21 +1625,21 @@ class NewPlanBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1654,7 +1654,7 @@ class NewPlanBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1667,7 +1667,7 @@ class NewPlanBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1680,7 +1680,7 @@ class NewPlanBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1689,8 +1689,8 @@ class NewPlanBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -1795,7 +1795,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -1838,7 +1838,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1896,21 +1896,21 @@ class NewPlanBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1925,7 +1925,7 @@ class NewPlanBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1938,7 +1938,7 @@ class NewPlanBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1951,7 +1951,7 @@ class NewPlanBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1960,8 +1960,8 @@ class NewPlanBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -2010,7 +2010,7 @@ class NewPlanBulkBpsPrice < Orb::Internal::Type::BaseModel class BulkBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume # # @return [Array] required :tiers, @@ -2090,7 +2090,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2133,7 +2133,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2191,21 +2191,21 @@ class NewPlanBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2220,7 +2220,7 @@ class NewPlanBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -2233,7 +2233,7 @@ class NewPlanBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2246,7 +2246,7 @@ class NewPlanBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2255,8 +2255,8 @@ class NewPlanBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -2377,7 +2377,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -2420,7 +2420,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2479,21 +2479,21 @@ class NewPlanThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2508,7 +2508,7 @@ class NewPlanThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -2521,7 +2521,7 @@ class NewPlanThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2534,7 +2534,7 @@ class NewPlanThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2543,8 +2543,8 @@ class NewPlanThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -2626,7 +2626,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] @@ -2669,7 +2669,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2727,21 +2727,21 @@ class NewPlanTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2756,7 +2756,7 @@ class NewPlanTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -2769,7 +2769,7 @@ class NewPlanTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2782,7 +2782,7 @@ class NewPlanTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2791,8 +2791,8 @@ class NewPlanTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -2874,7 +2874,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -2917,7 +2917,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -2976,21 +2976,21 @@ class NewPlanTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3005,7 +3005,7 @@ class NewPlanTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3018,7 +3018,7 @@ class NewPlanTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3031,7 +3031,7 @@ class NewPlanTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3040,8 +3040,8 @@ class NewPlanTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -3123,7 +3123,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -3166,7 +3166,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3224,21 +3224,21 @@ class NewPlanUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3253,7 +3253,7 @@ class NewPlanUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3266,7 +3266,7 @@ class NewPlanUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3279,7 +3279,7 @@ class NewPlanUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3288,8 +3288,8 @@ class NewPlanUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -3371,7 +3371,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] @@ -3414,7 +3414,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3473,21 +3473,21 @@ class NewPlanPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3502,7 +3502,7 @@ class NewPlanPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3515,7 +3515,7 @@ class NewPlanPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3528,7 +3528,7 @@ class NewPlanPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3537,8 +3537,8 @@ class NewPlanPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -3620,7 +3620,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -3663,7 +3663,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3722,21 +3722,21 @@ class NewPlanTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3751,7 +3751,7 @@ class NewPlanTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3764,7 +3764,7 @@ class NewPlanTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3777,7 +3777,7 @@ class NewPlanTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3786,8 +3786,8 @@ class NewPlanTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -3869,7 +3869,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -3912,7 +3912,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3971,21 +3971,21 @@ class NewPlanUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4000,7 +4000,7 @@ class NewPlanUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4013,7 +4013,7 @@ class NewPlanUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4026,7 +4026,7 @@ class NewPlanUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4035,8 +4035,8 @@ class NewPlanUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -4118,7 +4118,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -4161,7 +4161,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4220,21 +4220,21 @@ class NewPlanGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4249,7 +4249,7 @@ class NewPlanGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4262,7 +4262,7 @@ class NewPlanGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4275,7 +4275,7 @@ class NewPlanGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4284,8 +4284,8 @@ class NewPlanGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -4367,7 +4367,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -4410,7 +4410,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4470,21 +4470,21 @@ class NewPlanGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4499,7 +4499,7 @@ class NewPlanGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4512,7 +4512,7 @@ class NewPlanGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4525,7 +4525,7 @@ class NewPlanGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4534,8 +4534,8 @@ class NewPlanGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -4617,7 +4617,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -4660,7 +4660,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4720,21 +4720,21 @@ class NewPlanGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4749,7 +4749,7 @@ class NewPlanGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4762,7 +4762,7 @@ class NewPlanGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4775,7 +4775,7 @@ class NewPlanGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4784,8 +4784,8 @@ class NewPlanGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -4867,7 +4867,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -4910,7 +4910,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4969,21 +4969,21 @@ class NewPlanMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4998,7 +4998,7 @@ class NewPlanMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5011,7 +5011,7 @@ class NewPlanMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5024,7 +5024,7 @@ class NewPlanMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5033,8 +5033,8 @@ class NewPlanMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -5116,7 +5116,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] @@ -5159,7 +5159,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] @@ -5218,21 +5218,21 @@ class NewPlanBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5247,7 +5247,7 @@ class NewPlanBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5260,7 +5260,7 @@ class NewPlanBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5273,7 +5273,7 @@ class NewPlanBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5282,8 +5282,8 @@ class NewPlanBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -5365,7 +5365,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -5408,7 +5408,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5467,21 +5467,21 @@ class NewPlanGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5496,7 +5496,7 @@ class NewPlanGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5509,7 +5509,7 @@ class NewPlanGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5522,7 +5522,7 @@ class NewPlanGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5531,8 +5531,8 @@ class NewPlanGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -5614,7 +5614,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -5657,7 +5657,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -5716,21 +5716,21 @@ class NewPlanMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5745,7 +5745,7 @@ class NewPlanMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5758,7 +5758,7 @@ class NewPlanMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5771,7 +5771,7 @@ class NewPlanMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5780,8 +5780,8 @@ class NewPlanMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -5863,7 +5863,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -5906,7 +5906,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -5966,21 +5966,21 @@ class NewPlanScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5995,7 +5995,7 @@ class NewPlanScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6008,7 +6008,7 @@ class NewPlanScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6021,7 +6021,7 @@ class NewPlanScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6030,8 +6030,8 @@ class NewPlanScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -6113,7 +6113,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -6156,7 +6156,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6216,21 +6216,21 @@ class NewPlanScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::BaseMod # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6245,7 +6245,7 @@ class NewPlanScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::BaseMod # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6258,7 +6258,7 @@ class NewPlanScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::BaseMod # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6271,7 +6271,7 @@ class NewPlanScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::BaseMod # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6280,8 +6280,8 @@ class NewPlanScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::BaseMod # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -6363,7 +6363,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -6406,7 +6406,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6465,21 +6465,21 @@ class NewPlanCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6494,7 +6494,7 @@ class NewPlanCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6507,7 +6507,7 @@ class NewPlanCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6520,7 +6520,7 @@ class NewPlanCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6529,8 +6529,8 @@ class NewPlanCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -6612,7 +6612,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -6655,7 +6655,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6688,7 +6688,7 @@ module DurationUnit end # The status of the plan to create (either active or draft). If not specified, - # this defaults to active. + # this defaults to active. module Status extend Orb::Internal::Type::Enum diff --git a/lib/orb/models/plan_list_params.rb b/lib/orb/models/plan_list_params.rb index c414dbeb..5d20d996 100644 --- a/lib/orb/models/plan_list_params.rb +++ b/lib/orb/models/plan_list_params.rb @@ -30,7 +30,7 @@ class PlanListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/plan_update_params.rb b/lib/orb/models/plan_update_params.rb index 4b9b8900..05646396 100644 --- a/lib/orb/models/plan_update_params.rb +++ b/lib/orb/models/plan_update_params.rb @@ -10,16 +10,16 @@ class PlanUpdateParams < Orb::Internal::Type::BaseModel # @!attribute external_plan_id # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. # # @return [String, nil] optional :external_plan_id, String, nil?: true # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true diff --git a/lib/orb/models/plans/external_plan_id_update_params.rb b/lib/orb/models/plans/external_plan_id_update_params.rb index a20c40c9..6cf93aa8 100644 --- a/lib/orb/models/plans/external_plan_id_update_params.rb +++ b/lib/orb/models/plans/external_plan_id_update_params.rb @@ -11,16 +11,16 @@ class ExternalPlanIDUpdateParams < Orb::Internal::Type::BaseModel # @!attribute external_plan_id # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. # # @return [String, nil] optional :external_plan_id, String, nil?: true # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true diff --git a/lib/orb/models/price.rb b/lib/orb/models/price.rb index 082a16d7..21cab189 100644 --- a/lib/orb/models/price.rb +++ b/lib/orb/models/price.rb @@ -3,15 +3,15 @@ module Orb module Models # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @see Orb::Resources::Prices#create module Price @@ -156,9 +156,9 @@ class UnitPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -414,7 +414,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -438,7 +438,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -590,9 +590,9 @@ class PackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -848,7 +848,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -872,7 +872,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -902,7 +902,7 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @!attribute package_size # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating # # @return [Integer] required :package_size, Integer @@ -1037,9 +1037,9 @@ class MatrixPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -1319,8 +1319,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -1345,7 +1345,7 @@ class MatrixValue < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -1369,7 +1369,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -1505,9 +1505,9 @@ class TieredPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -1763,7 +1763,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -1787,7 +1787,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -1969,9 +1969,9 @@ class TieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -2227,7 +2227,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -2251,7 +2251,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -2289,7 +2289,7 @@ module PriceType class TieredBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers # # @return [Array] required :tiers, @@ -2446,9 +2446,9 @@ class BpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -2722,7 +2722,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -2746,7 +2746,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -2887,9 +2887,9 @@ class BulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -3044,7 +3044,7 @@ module DurationUnit class BulkBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume # # @return [Array] required :tiers, @@ -3187,7 +3187,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -3211,7 +3211,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -3352,9 +3352,9 @@ class BulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -3643,7 +3643,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -3667,7 +3667,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -3808,9 +3808,9 @@ class ThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -4066,7 +4066,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -4090,7 +4090,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -4227,9 +4227,9 @@ class TieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -4485,7 +4485,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -4509,7 +4509,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -4651,9 +4651,9 @@ class GroupedTieredPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -4904,7 +4904,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -4928,7 +4928,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -5067,9 +5067,9 @@ class TieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -5325,7 +5325,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -5349,7 +5349,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -5490,9 +5490,9 @@ class TieredPackageWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -5749,7 +5749,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -5773,7 +5773,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -5914,9 +5914,9 @@ class PackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -6172,7 +6172,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -6196,7 +6196,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -6333,9 +6333,9 @@ class UnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -6591,7 +6591,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -6615,7 +6615,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -6762,9 +6762,9 @@ class MatrixWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -7051,8 +7051,8 @@ class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -7077,7 +7077,7 @@ class MatrixValue < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -7101,7 +7101,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -7240,9 +7240,9 @@ class TieredWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -7498,7 +7498,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -7522,7 +7522,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -7661,9 +7661,9 @@ class UnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -7919,7 +7919,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -7943,7 +7943,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -8087,9 +8087,9 @@ class GroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -8340,7 +8340,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -8364,7 +8364,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -8511,9 +8511,9 @@ class GroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -8764,7 +8764,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -8788,7 +8788,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -8935,9 +8935,9 @@ class GroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -9188,7 +9188,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -9212,7 +9212,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -9358,9 +9358,9 @@ class MatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -9611,7 +9611,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -9635,7 +9635,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -9779,9 +9779,9 @@ class BulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -10032,7 +10032,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -10056,7 +10056,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -10202,9 +10202,9 @@ class GroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -10455,7 +10455,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -10479,7 +10479,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -10625,9 +10625,9 @@ class MaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -10878,7 +10878,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -10902,7 +10902,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -11043,9 +11043,9 @@ class ScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -11302,7 +11302,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -11326,7 +11326,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -11467,9 +11467,9 @@ class ScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -11726,7 +11726,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -11750,7 +11750,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -11896,9 +11896,9 @@ class CumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -12149,7 +12149,7 @@ class Item < Orb::Internal::Type::BaseModel class Maximum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -12173,7 +12173,7 @@ class Maximum < Orb::Internal::Type::BaseModel class Minimum < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] diff --git a/lib/orb/models/price_create_params.rb b/lib/orb/models/price_create_params.rb index 31d8d70e..db287356 100644 --- a/lib/orb/models/price_create_params.rb +++ b/lib/orb/models/price_create_params.rb @@ -44,21 +44,21 @@ class PriceCreateParams < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -79,7 +79,7 @@ class PriceCreateParams < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -92,7 +92,7 @@ class PriceCreateParams < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -101,8 +101,8 @@ class PriceCreateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -402,7 +402,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit] @@ -444,7 +444,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit] @@ -479,7 +479,7 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @!attribute package_size # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating # # @return [Integer] required :package_size, Integer @@ -525,8 +525,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -586,8 +586,8 @@ class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -655,7 +655,7 @@ class Tier < Orb::Internal::Type::BaseModel class TieredBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers # # @return [Array] required :tiers, @@ -730,7 +730,7 @@ class BpsConfig < Orb::Internal::Type::BaseModel class BulkBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume # # @return [Array] required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier] } diff --git a/lib/orb/models/price_evaluate_params.rb b/lib/orb/models/price_evaluate_params.rb index ebc19959..b7dc5e1f 100644 --- a/lib/orb/models/price_evaluate_params.rb +++ b/lib/orb/models/price_evaluate_params.rb @@ -34,16 +34,16 @@ class PriceEvaluateParams < Orb::Internal::Type::BaseModel # @!attribute filter # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the underlying billable metric + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the underlying billable metric # # @return [String, nil] optional :filter, String, nil?: true # @!attribute [r] grouping_keys # Properties (or - # [computed properties](/extensibility/advanced-metrics#computed-properties)) used - # to group the underlying billable metric + # [computed properties](/extensibility/advanced-metrics#computed-properties)) used + # to group the underlying billable metric # # @return [Array, nil] optional :grouping_keys, Orb::Internal::Type::ArrayOf[String] diff --git a/lib/orb/models/price_list_params.rb b/lib/orb/models/price_list_params.rb index 6b3a7868..148e572e 100644 --- a/lib/orb/models/price_list_params.rb +++ b/lib/orb/models/price_list_params.rb @@ -10,7 +10,7 @@ class PriceListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/price_update_params.rb b/lib/orb/models/price_update_params.rb index 61731dd5..a08f0df3 100644 --- a/lib/orb/models/price_update_params.rb +++ b/lib/orb/models/price_update_params.rb @@ -10,8 +10,8 @@ class PriceUpdateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true diff --git a/lib/orb/models/prices/external_price_id_update_params.rb b/lib/orb/models/prices/external_price_id_update_params.rb index 7ff1d1f5..7c97e065 100644 --- a/lib/orb/models/prices/external_price_id_update_params.rb +++ b/lib/orb/models/prices/external_price_id_update_params.rb @@ -11,8 +11,8 @@ class ExternalPriceIDUpdateParams < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true diff --git a/lib/orb/models/subscription.rb b/lib/orb/models/subscription.rb index 6fcffb03..fe0956b3 100644 --- a/lib/orb/models/subscription.rb +++ b/lib/orb/models/subscription.rb @@ -11,14 +11,14 @@ class Subscription < Orb::Internal::Type::BaseModel # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class Subscription < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class Subscription < Orb::Internal::Type::BaseModel # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class Subscription < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class Subscription < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class Subscription < Orb::Internal::Type::BaseModel # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -192,24 +192,24 @@ class Subscription < Orb::Internal::Type::BaseModel # @!parse # # A [subscription](/core-concepts#subscription) represents the purchase of a plan - # # by a customer. + # # by a customer. # # - # # By default, subscriptions begin on the day that they're created and renew - # # automatically for each billing cycle at the cadence that's configured in the - # # plan definition. + # # By default, subscriptions begin on the day that they're created and renew + # # automatically for each billing cycle at the cadence that's configured in the + # # plan definition. # # - # # Subscriptions also default to **beginning of month alignment**, which means the - # # first invoice issued for the subscription will have pro-rated charges between - # # the `start_date` and the first of the following month. Subsequent billing - # # periods will always start and end on a month boundary (e.g. subsequent month - # # starts for monthly billing). + # # Subscriptions also default to **beginning of month alignment**, which means the + # # first invoice issued for the subscription will have pro-rated charges between + # # the `start_date` and the first of the following month. Subsequent billing + # # periods will always start and end on a month boundary (e.g. subsequent month + # # starts for monthly billing). # # - # # Depending on the plan configuration, any _flat_ recurring fees will be billed - # # either at the beginning (in-advance) or end (in-arrears) of each billing cycle. - # # Plans default to **in-advance billing**. Usage-based fees are billed in arrears - # # as usage is accumulated. In the normal course of events, you can expect an - # # invoice to contain usage-based charges for the previous period, and a recurring - # # fee for the following period. + # # Depending on the plan configuration, any _flat_ recurring fees will be billed + # # either at the beginning (in-advance) or end (in-arrears) of each billing cycle. + # # Plans default to **in-advance billing**. Usage-based fees are billed in arrears + # # as usage is accumulated. In the normal course of events, you can expect an + # # invoice to contain usage-based charges for the previous period, and a recurring + # # fee for the following period. # # # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -350,7 +350,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -369,7 +369,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -412,7 +412,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -425,7 +425,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -486,14 +486,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -554,7 +554,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -567,7 +567,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -630,14 +630,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -689,24 +689,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -817,7 +817,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -883,7 +883,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -969,7 +969,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -1013,7 +1013,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1050,23 +1050,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1079,7 +1079,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1088,37 +1088,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] diff --git a/lib/orb/models/subscription_cancel_params.rb b/lib/orb/models/subscription_cancel_params.rb index aff99881..649e9f17 100644 --- a/lib/orb/models/subscription_cancel_params.rb +++ b/lib/orb/models/subscription_cancel_params.rb @@ -16,15 +16,15 @@ class SubscriptionCancelParams < Orb::Internal::Type::BaseModel # @!attribute allow_invoice_credit_or_void # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. # # @return [Boolean, nil] optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true # @!attribute cancellation_date # The date that the cancellation should take effect. This parameter can only be - # passed if the `cancel_option` is `requested_date`. + # passed if the `cancel_option` is `requested_date`. # # @return [Time, nil] optional :cancellation_date, Time, nil?: true diff --git a/lib/orb/models/subscription_cancel_response.rb b/lib/orb/models/subscription_cancel_response.rb index 3147c799..47a83381 100644 --- a/lib/orb/models/subscription_cancel_response.rb +++ b/lib/orb/models/subscription_cancel_response.rb @@ -11,14 +11,14 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -332,7 +332,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -351,7 +351,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -394,7 +394,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -407,7 +407,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -468,14 +468,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -536,7 +536,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -549,7 +549,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -612,14 +612,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -671,24 +671,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -800,7 +800,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -866,7 +866,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -952,7 +952,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -996,7 +996,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1033,23 +1033,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1062,7 +1062,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1071,37 +1071,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] diff --git a/lib/orb/models/subscription_create_params.rb b/lib/orb/models/subscription_create_params.rb index abed9529..a19498a4 100644 --- a/lib/orb/models/subscription_create_params.rb +++ b/lib/orb/models/subscription_create_params.rb @@ -10,7 +10,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute add_adjustments # Additional adjustments to be added to the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :add_adjustments, @@ -19,7 +19,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute add_prices # Additional prices to be added to the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :add_prices, @@ -37,8 +37,8 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. If not specified, this - # defaults to the behavior configured for this customer. + # charged with the saved payment method on the due date. If not specified, this + # defaults to the behavior configured for this customer. # # @return [Boolean, nil] optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -57,8 +57,8 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute coupon_redemption_code # Redemption code to be used for this subscription. If the coupon cannot be found - # by its redemption code, or cannot be redeemed, an error response will be - # returned and the subscription creation or plan change will not be scheduled. + # by its redemption code, or cannot be redeemed, an error response will be + # returned and the subscription creation or plan change will not be scheduled. # # @return [String, nil] optional :coupon_redemption_code, String, nil?: true @@ -75,7 +75,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute default_invoice_memo # Determines the default memo on this subscription's invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] optional :default_invoice_memo, String, nil?: true @@ -104,16 +104,16 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute external_plan_id # The external_plan_id of the plan that the given subscription should be switched - # to. Note that either this property or `plan_id` must be specified. + # to. Note that either this property or `plan_id` must be specified. # # @return [String, nil] optional :external_plan_id, String, nil?: true # @!attribute filter # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. # # @return [String, nil] optional :filter, String, nil?: true @@ -126,24 +126,24 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute invoicing_threshold # When this subscription's accrued usage reaches this threshold, an invoice will - # be issued for the subscription. If not specified, invoices will only be issued - # at the end of the billing period. + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. # # @return [String, nil] optional :invoicing_threshold, String, nil?: true # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. If not provided, this defaults to the value specified in the plan. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. If not provided, this defaults to the value specified in the plan. # # @return [Integer, nil] optional :net_terms, Integer, nil?: true @@ -155,14 +155,14 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute plan_id # The plan that the given subscription should be switched to. Note that either - # this property or `external_plan_id` must be specified. + # this property or `external_plan_id` must be specified. # # @return [String, nil] optional :plan_id, String, nil?: true # @!attribute plan_version_number # Specifies which version of the plan to subscribe to. If null, the default - # version will be used. + # version will be used. # # @return [Integer, nil] optional :plan_version_number, Integer, nil?: true @@ -175,7 +175,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute remove_adjustments # Plan adjustments to be removed from the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :remove_adjustments, @@ -184,7 +184,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute remove_prices # Plan prices to be removed from the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :remove_prices, @@ -193,8 +193,8 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute replace_adjustments # Plan adjustments to be replaced with additional adjustments on the subscription. - # (Only available for accounts that have migrated off of legacy subscription - # overrides) + # (Only available for accounts that have migrated off of legacy subscription + # overrides) # # @return [Array, nil] optional :replace_adjustments, @@ -203,7 +203,7 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute replace_prices # Plan prices to be replaced with additional prices on the subscription. (Only - # available for accounts that have migrated off of legacy subscription overrides) + # available for accounts that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :replace_prices, @@ -217,19 +217,19 @@ class SubscriptionCreateParams < Orb::Internal::Type::BaseModel # @!attribute trial_duration_days # The duration of the trial period in days. If not provided, this defaults to the - # value specified in the plan. If `0` is provided, the trial on the plan will be - # skipped. + # value specified in the plan. If `0` is provided, the trial on the plan will be + # skipped. # # @return [Integer, nil] optional :trial_duration_days, Integer, nil?: true # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. # # @return [Array, nil] optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true @@ -317,7 +317,7 @@ class AddAdjustment < Orb::Internal::Type::BaseModel # @!attribute end_date # The end date of the adjustment interval. This is the date that the adjustment - # will stop affecting prices on the subscription. + # will stop affecting prices on the subscription. # # @return [Time, nil] optional :end_date, Time, nil?: true @@ -330,8 +330,8 @@ class AddAdjustment < Orb::Internal::Type::BaseModel # @!attribute start_date # The start date of the adjustment interval. This is the date that the adjustment - # will start affecting prices on the subscription. If null, the adjustment will - # start when the phase or subscription starts. + # will start affecting prices on the subscription. If null, the adjustment will + # start when the phase or subscription starts. # # @return [Time, nil] optional :start_date, Time, nil?: true @@ -386,7 +386,7 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -433,7 +433,7 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -472,7 +472,7 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -517,7 +517,7 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -557,7 +557,7 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -594,7 +594,7 @@ class AddPrice < Orb::Internal::Type::BaseModel # @!attribute discounts # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this - # price. + # price. # # @return [Array, nil] optional :discounts, @@ -603,8 +603,8 @@ class AddPrice < Orb::Internal::Type::BaseModel # @!attribute end_date # The end date of the price interval. This is the date that the price will stop - # billing on the subscription. If null, billing will end when the phase or - # subscription ends. + # billing on the subscription. If null, billing will end when the phase or + # subscription ends. # # @return [Time, nil] optional :end_date, Time, nil?: true @@ -617,14 +617,14 @@ class AddPrice < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for - # this price. + # this price. # # @return [String, nil] optional :maximum_amount, String, nil?: true # @!attribute minimum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for - # this price. + # this price. # # @return [String, nil] optional :minimum_amount, String, nil?: true @@ -649,8 +649,8 @@ class AddPrice < Orb::Internal::Type::BaseModel # @!attribute start_date # The start date of the price interval. This is the date that the price will start - # billing on the subscription. If null, billing will start when the phase or - # subscription starts. + # billing on the subscription. If null, billing will start when the phase or + # subscription starts. # # @return [Time, nil] optional :start_date, Time, nil?: true @@ -701,14 +701,14 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. # # @return [String] required :currency, String # @!attribute expires_at_end_of_cadence # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. # # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean @@ -761,14 +761,14 @@ class Discount < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. # # @return [Float, nil] optional :percentage_discount, Float, nil?: true # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float, nil] optional :usage_discount, Float, nil?: true @@ -910,21 +910,21 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -939,7 +939,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -952,7 +952,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -965,7 +965,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -974,15 +974,15 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -1082,7 +1082,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] @@ -1125,7 +1125,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1185,21 +1185,21 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1214,7 +1214,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1227,7 +1227,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1240,7 +1240,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1249,15 +1249,15 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -1334,7 +1334,7 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @!attribute package_size # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating # # @return [Integer] required :package_size, Integer @@ -1365,7 +1365,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -1408,7 +1408,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -1468,21 +1468,21 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1497,7 +1497,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1510,7 +1510,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1523,7 +1523,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1532,15 +1532,15 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -1644,8 +1644,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -1683,7 +1683,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] @@ -1726,7 +1726,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1786,21 +1786,21 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1815,7 +1815,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1828,7 +1828,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1841,7 +1841,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1850,15 +1850,15 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -1988,7 +1988,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] @@ -2031,7 +2031,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2091,21 +2091,21 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2120,7 +2120,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -2133,7 +2133,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2146,7 +2146,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2155,15 +2155,15 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -2234,7 +2234,7 @@ module Cadence class TieredBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers # # @return [Array] required :tiers, @@ -2305,7 +2305,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2348,7 +2348,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2408,21 +2408,21 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2437,7 +2437,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -2450,7 +2450,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2463,7 +2463,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2472,15 +2472,15 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -2587,7 +2587,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2630,7 +2630,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2690,21 +2690,21 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2719,7 +2719,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -2732,7 +2732,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2745,7 +2745,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2754,15 +2754,15 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -2813,7 +2813,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel class BulkBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume # # @return [Array] required :tiers, @@ -2893,7 +2893,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2936,7 +2936,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2996,21 +2996,21 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3025,7 +3025,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3038,7 +3038,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3051,7 +3051,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3060,15 +3060,15 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -3191,7 +3191,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -3234,7 +3234,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3293,21 +3293,21 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3322,7 +3322,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3335,7 +3335,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3348,7 +3348,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3357,15 +3357,15 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -3449,7 +3449,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] @@ -3492,7 +3492,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3551,21 +3551,21 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3580,7 +3580,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3593,7 +3593,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3606,7 +3606,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3615,15 +3615,15 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -3707,7 +3707,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -3750,7 +3750,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -3809,21 +3809,21 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3838,7 +3838,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3851,7 +3851,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3864,7 +3864,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3873,15 +3873,15 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -3965,7 +3965,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -4008,7 +4008,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4067,21 +4067,21 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4096,7 +4096,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4109,7 +4109,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4122,7 +4122,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4131,15 +4131,15 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -4223,7 +4223,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] @@ -4266,7 +4266,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4326,21 +4326,21 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4355,7 +4355,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4368,7 +4368,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4381,7 +4381,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4390,15 +4390,15 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -4482,7 +4482,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -4525,7 +4525,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4584,21 +4584,21 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4613,7 +4613,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4626,7 +4626,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4639,7 +4639,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4648,15 +4648,15 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -4740,7 +4740,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -4783,7 +4783,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4842,21 +4842,21 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4871,7 +4871,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4884,7 +4884,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4897,7 +4897,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4906,15 +4906,15 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -4998,7 +4998,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -5041,7 +5041,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5100,21 +5100,21 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5129,7 +5129,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5142,7 +5142,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5155,7 +5155,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5164,15 +5164,15 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -5256,7 +5256,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -5299,7 +5299,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5359,21 +5359,21 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5388,7 +5388,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5401,7 +5401,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5414,7 +5414,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5423,15 +5423,15 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -5515,7 +5515,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -5558,7 +5558,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5617,21 +5617,21 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5646,7 +5646,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5659,7 +5659,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5672,7 +5672,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5681,15 +5681,15 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -5773,7 +5773,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -5816,7 +5816,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5876,21 +5876,21 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5905,7 +5905,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5918,7 +5918,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5931,7 +5931,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5940,15 +5940,15 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -6032,7 +6032,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -6075,7 +6075,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6135,21 +6135,21 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6164,7 +6164,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6177,7 +6177,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6190,7 +6190,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6199,15 +6199,15 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -6291,7 +6291,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -6334,7 +6334,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6394,21 +6394,21 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6423,7 +6423,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6436,7 +6436,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6449,7 +6449,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6458,15 +6458,15 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -6550,7 +6550,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -6593,7 +6593,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6653,21 +6653,21 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6682,7 +6682,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6695,7 +6695,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6708,7 +6708,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6717,15 +6717,15 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -6809,7 +6809,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -6852,7 +6852,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -6912,21 +6912,21 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6941,7 +6941,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6954,7 +6954,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6967,7 +6967,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6976,15 +6976,15 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -7068,7 +7068,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -7111,7 +7111,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -7171,21 +7171,21 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -7200,7 +7200,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -7213,7 +7213,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -7226,7 +7226,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -7235,15 +7235,15 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -7327,7 +7327,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] @@ -7370,7 +7370,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] @@ -7429,21 +7429,21 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -7458,7 +7458,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -7471,7 +7471,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -7484,7 +7484,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -7493,15 +7493,15 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -7585,7 +7585,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -7628,7 +7628,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -7664,24 +7664,24 @@ module DurationUnit class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -7809,7 +7809,7 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -7856,7 +7856,7 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -7895,7 +7895,7 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -7940,7 +7940,7 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -7980,7 +7980,7 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -8023,7 +8023,7 @@ class ReplacePrice < Orb::Internal::Type::BaseModel # @!attribute discounts # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the - # replacement price. + # replacement price. # # @return [Array, nil] optional :discounts, @@ -8044,14 +8044,14 @@ class ReplacePrice < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for - # the replacement price. + # the replacement price. # # @return [String, nil] optional :maximum_amount, String, nil?: true # @!attribute minimum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for - # the replacement price. + # the replacement price. # # @return [String, nil] optional :minimum_amount, String, nil?: true @@ -8113,14 +8113,14 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. # # @return [String] required :currency, String # @!attribute expires_at_end_of_cadence # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. # # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean @@ -8173,14 +8173,14 @@ class Discount < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. # # @return [Float, nil] optional :percentage_discount, Float, nil?: true # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float, nil] optional :usage_discount, Float, nil?: true @@ -8324,21 +8324,21 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -8353,7 +8353,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -8366,7 +8366,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -8379,7 +8379,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -8388,15 +8388,15 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -8496,7 +8496,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] @@ -8539,7 +8539,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] @@ -8599,21 +8599,21 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -8628,7 +8628,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -8641,7 +8641,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -8654,7 +8654,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -8663,15 +8663,15 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -8748,7 +8748,7 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @!attribute package_size # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating # # @return [Integer] required :package_size, Integer @@ -8779,7 +8779,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -8822,7 +8822,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -8882,21 +8882,21 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -8911,7 +8911,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -8924,7 +8924,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -8937,7 +8937,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -8946,15 +8946,15 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -9058,8 +9058,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -9097,7 +9097,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] @@ -9140,7 +9140,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] @@ -9200,21 +9200,21 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -9229,7 +9229,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -9242,7 +9242,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -9255,7 +9255,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -9264,15 +9264,15 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -9402,7 +9402,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] @@ -9445,7 +9445,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] @@ -9505,21 +9505,21 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -9534,7 +9534,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -9547,7 +9547,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -9560,7 +9560,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -9569,15 +9569,15 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -9648,7 +9648,7 @@ module Cadence class TieredBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers # # @return [Array] required :tiers, @@ -9719,7 +9719,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -9762,7 +9762,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -9822,21 +9822,21 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -9851,7 +9851,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -9864,7 +9864,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -9877,7 +9877,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -9886,15 +9886,15 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -10001,7 +10001,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -10044,7 +10044,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -10104,21 +10104,21 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -10133,7 +10133,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -10146,7 +10146,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -10159,7 +10159,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -10168,15 +10168,15 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -10227,7 +10227,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel class BulkBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume # # @return [Array] required :tiers, @@ -10311,7 +10311,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -10354,7 +10354,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -10414,21 +10414,21 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -10443,7 +10443,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -10456,7 +10456,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -10469,7 +10469,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -10478,15 +10478,15 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -10609,7 +10609,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -10652,7 +10652,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -10711,21 +10711,21 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -10740,7 +10740,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -10753,7 +10753,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -10766,7 +10766,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -10775,15 +10775,15 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -10867,7 +10867,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] @@ -10910,7 +10910,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] @@ -10969,21 +10969,21 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -10998,7 +10998,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -11011,7 +11011,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -11024,7 +11024,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -11033,15 +11033,15 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -11125,7 +11125,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -11168,7 +11168,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -11227,21 +11227,21 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -11256,7 +11256,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -11269,7 +11269,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -11282,7 +11282,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -11291,15 +11291,15 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -11383,7 +11383,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -11426,7 +11426,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -11485,21 +11485,21 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -11514,7 +11514,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -11527,7 +11527,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -11540,7 +11540,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -11549,15 +11549,15 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -11641,7 +11641,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] @@ -11684,7 +11684,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] @@ -11744,21 +11744,21 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -11773,7 +11773,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -11786,7 +11786,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -11799,7 +11799,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -11808,15 +11808,15 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -11900,7 +11900,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -11943,7 +11943,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -12002,21 +12002,21 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -12031,7 +12031,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -12044,7 +12044,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -12057,7 +12057,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -12066,15 +12066,15 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -12158,7 +12158,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -12201,7 +12201,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -12260,21 +12260,21 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -12289,7 +12289,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -12302,7 +12302,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -12315,7 +12315,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -12324,15 +12324,15 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -12416,7 +12416,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -12459,7 +12459,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -12518,21 +12518,21 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -12547,7 +12547,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -12560,7 +12560,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -12573,7 +12573,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -12582,15 +12582,15 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -12674,7 +12674,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -12717,7 +12717,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -12777,21 +12777,21 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -12806,7 +12806,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -12819,7 +12819,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -12832,7 +12832,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -12841,15 +12841,15 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -12933,7 +12933,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -12976,7 +12976,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -13035,21 +13035,21 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -13064,7 +13064,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -13077,7 +13077,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -13090,7 +13090,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -13099,15 +13099,15 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -13191,7 +13191,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -13234,7 +13234,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -13294,21 +13294,21 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -13323,7 +13323,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -13336,7 +13336,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -13349,7 +13349,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -13358,15 +13358,15 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -13450,7 +13450,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -13493,7 +13493,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -13553,21 +13553,21 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -13582,7 +13582,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -13595,7 +13595,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -13608,7 +13608,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -13617,15 +13617,15 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -13709,7 +13709,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -13752,7 +13752,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -13812,21 +13812,21 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -13841,7 +13841,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -13854,7 +13854,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -13867,7 +13867,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -13876,15 +13876,15 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -13968,7 +13968,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -14011,7 +14011,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -14071,21 +14071,21 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -14100,7 +14100,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -14113,7 +14113,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -14126,7 +14126,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -14135,15 +14135,15 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -14227,7 +14227,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -14270,7 +14270,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -14330,21 +14330,21 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -14359,7 +14359,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -14372,7 +14372,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -14385,7 +14385,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -14394,15 +14394,15 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -14486,7 +14486,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -14529,7 +14529,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -14589,21 +14589,21 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -14618,7 +14618,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -14631,7 +14631,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -14644,7 +14644,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -14653,15 +14653,15 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -14745,7 +14745,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] @@ -14788,7 +14788,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] @@ -14847,21 +14847,21 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -14876,7 +14876,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -14889,7 +14889,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -14902,7 +14902,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -14911,15 +14911,15 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -15003,7 +15003,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -15046,7 +15046,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] diff --git a/lib/orb/models/subscription_create_response.rb b/lib/orb/models/subscription_create_response.rb index c1908590..cf85cc14 100644 --- a/lib/orb/models/subscription_create_response.rb +++ b/lib/orb/models/subscription_create_response.rb @@ -11,14 +11,14 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -332,7 +332,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -351,7 +351,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -394,7 +394,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -407,7 +407,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -468,14 +468,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -536,7 +536,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -549,7 +549,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -612,14 +612,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -671,24 +671,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -800,7 +800,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -866,7 +866,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -952,7 +952,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -996,7 +996,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1033,23 +1033,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1062,7 +1062,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1071,37 +1071,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] diff --git a/lib/orb/models/subscription_fetch_costs_params.rb b/lib/orb/models/subscription_fetch_costs_params.rb index 7c11ee19..fa38577c 100644 --- a/lib/orb/models/subscription_fetch_costs_params.rb +++ b/lib/orb/models/subscription_fetch_costs_params.rb @@ -28,9 +28,9 @@ class SubscriptionFetchCostsParams < Orb::Internal::Type::BaseModel # @!attribute view_mode # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. # # @return [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil] optional :view_mode, enum: -> { Orb::Models::SubscriptionFetchCostsParams::ViewMode }, nil?: true @@ -47,9 +47,9 @@ class SubscriptionFetchCostsParams < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. module ViewMode extend Orb::Internal::Type::Enum diff --git a/lib/orb/models/subscription_fetch_schedule_params.rb b/lib/orb/models/subscription_fetch_schedule_params.rb index 04611aa6..ddaf3eba 100644 --- a/lib/orb/models/subscription_fetch_schedule_params.rb +++ b/lib/orb/models/subscription_fetch_schedule_params.rb @@ -10,7 +10,7 @@ class SubscriptionFetchScheduleParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/subscription_fetch_schedule_response.rb b/lib/orb/models/subscription_fetch_schedule_response.rb index 992bf0e8..ecd1cb8e 100644 --- a/lib/orb/models/subscription_fetch_schedule_response.rb +++ b/lib/orb/models/subscription_fetch_schedule_response.rb @@ -43,8 +43,8 @@ class Plan < Orb::Internal::Type::BaseModel # @!attribute external_plan_id # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. # # @return [String, nil] required :external_plan_id, String, nil?: true diff --git a/lib/orb/models/subscription_fetch_usage_params.rb b/lib/orb/models/subscription_fetch_usage_params.rb index 52444bd5..66ceb58d 100644 --- a/lib/orb/models/subscription_fetch_usage_params.rb +++ b/lib/orb/models/subscription_fetch_usage_params.rb @@ -10,8 +10,8 @@ class SubscriptionFetchUsageParams < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # When specified in conjunction with `group_by`, this parameter filters usage to a - # single billable metric. Note that both `group_by` and `billable_metric_id` must - # be specified together. + # single billable metric. Note that both `group_by` and `billable_metric_id` must + # be specified together. # # @return [String, nil] optional :billable_metric_id, String, nil?: true @@ -62,9 +62,9 @@ class SubscriptionFetchUsageParams < Orb::Internal::Type::BaseModel # @!attribute view_mode # Controls whether Orb returns cumulative usage since the start of the billing - # period, or incremental day-by-day usage. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day usage. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. # # @return [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil] optional :view_mode, enum: -> { Orb::Models::SubscriptionFetchUsageParams::ViewMode }, nil?: true @@ -115,9 +115,9 @@ module Granularity end # Controls whether Orb returns cumulative usage since the start of the billing - # period, or incremental day-by-day usage. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day usage. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. module ViewMode extend Orb::Internal::Type::Enum diff --git a/lib/orb/models/subscription_list_params.rb b/lib/orb/models/subscription_list_params.rb index 004c1261..eb083b28 100644 --- a/lib/orb/models/subscription_list_params.rb +++ b/lib/orb/models/subscription_list_params.rb @@ -30,7 +30,7 @@ class SubscriptionListParams < Orb::Internal::Type::BaseModel # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. # # @return [String, nil] optional :cursor, String, nil?: true diff --git a/lib/orb/models/subscription_price_intervals_params.rb b/lib/orb/models/subscription_price_intervals_params.rb index 39b0be3f..9a6adb8f 100644 --- a/lib/orb/models/subscription_price_intervals_params.rb +++ b/lib/orb/models/subscription_price_intervals_params.rb @@ -31,8 +31,8 @@ class SubscriptionPriceIntervalsParams < Orb::Internal::Type::BaseModel # @!attribute allow_invoice_credit_or_void # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. # # @return [Boolean, nil] optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true @@ -83,7 +83,7 @@ class SubscriptionPriceIntervalsParams < Orb::Internal::Type::BaseModel class Add < Orb::Internal::Type::BaseModel # @!attribute start_date # The start date of the price interval. This is the date that the price will start - # billing on the subscription. + # billing on the subscription. # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate] required :start_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::StartDate } @@ -106,7 +106,7 @@ class Add < Orb::Internal::Type::BaseModel # @!attribute end_date # The end date of the price interval. This is the date that the price will stop - # billing on the subscription. + # billing on the subscription. # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] optional :end_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::Add::EndDate }, nil?: true @@ -119,9 +119,9 @@ class Add < Orb::Internal::Type::BaseModel # @!attribute filter # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. # # @return [String, nil] optional :filter, String, nil?: true @@ -136,14 +136,14 @@ class Add < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount that will be billed for this price interval for a given - # billing period. + # billing period. # # @return [Float, nil] optional :maximum_amount, Float, nil?: true # @!attribute minimum_amount # The minimum amount that will be billed for this price interval for a given - # billing period. + # billing period. # # @return [Float, nil] optional :minimum_amount, Float, nil?: true @@ -162,11 +162,11 @@ class Add < Orb::Internal::Type::BaseModel # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. # # @return [Array, nil] optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true @@ -206,7 +206,7 @@ class Add < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void # The start date of the price interval. This is the date that the price will start - # billing on the subscription. + # billing on the subscription. # # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#start_date module StartDate @@ -238,14 +238,14 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. # # @return [String] required :currency, String # @!attribute expires_at_end_of_cadence # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. # # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean @@ -326,7 +326,7 @@ class PercentageDiscountCreationParams < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -348,7 +348,7 @@ class UsageDiscountCreationParams < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for. + # discount is for. # # @return [Float] required :usage_discount, Float @@ -368,7 +368,7 @@ class UsageDiscountCreationParams < Orb::Internal::Type::BaseModel end # The end date of the price interval. This is the date that the price will stop - # billing on the subscription. + # billing on the subscription. # # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#end_date module EndDate @@ -531,21 +531,21 @@ class NewFloatingUnitPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -566,7 +566,7 @@ class NewFloatingUnitPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -579,7 +579,7 @@ class NewFloatingUnitPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -588,8 +588,8 @@ class NewFloatingUnitPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -687,7 +687,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit] @@ -730,7 +730,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit] @@ -796,21 +796,21 @@ class NewFloatingPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -831,7 +831,7 @@ class NewFloatingPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -844,7 +844,7 @@ class NewFloatingPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -853,8 +853,8 @@ class NewFloatingPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -929,7 +929,7 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @!attribute package_size # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating # # @return [Integer] required :package_size, Integer @@ -960,7 +960,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -1003,7 +1003,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -1069,21 +1069,21 @@ class NewFloatingMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1104,7 +1104,7 @@ class NewFloatingMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1117,7 +1117,7 @@ class NewFloatingMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1126,8 +1126,8 @@ class NewFloatingMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -1229,8 +1229,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -1268,7 +1268,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit] @@ -1311,7 +1311,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1377,21 +1377,21 @@ class NewFloatingMatrixWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1412,7 +1412,7 @@ class NewFloatingMatrixWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1425,7 +1425,7 @@ class NewFloatingMatrixWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1434,8 +1434,8 @@ class NewFloatingMatrixWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -1544,8 +1544,8 @@ class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -1583,7 +1583,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -1626,7 +1626,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1692,21 +1692,21 @@ class NewFloatingTieredPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1727,7 +1727,7 @@ class NewFloatingTieredPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1740,7 +1740,7 @@ class NewFloatingTieredPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1749,8 +1749,8 @@ class NewFloatingTieredPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -1878,7 +1878,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit] @@ -1921,7 +1921,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1987,21 +1987,21 @@ class NewFloatingTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2022,7 +2022,7 @@ class NewFloatingTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2035,7 +2035,7 @@ class NewFloatingTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2044,8 +2044,8 @@ class NewFloatingTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -2114,7 +2114,7 @@ module Cadence class TieredBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers # # @return [Array] required :tiers, @@ -2185,7 +2185,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2228,7 +2228,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2294,21 +2294,21 @@ class NewFloatingBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2329,7 +2329,7 @@ class NewFloatingBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2342,7 +2342,7 @@ class NewFloatingBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2351,8 +2351,8 @@ class NewFloatingBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -2457,7 +2457,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2500,7 +2500,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2566,21 +2566,21 @@ class NewFloatingBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2601,7 +2601,7 @@ class NewFloatingBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2614,7 +2614,7 @@ class NewFloatingBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2623,8 +2623,8 @@ class NewFloatingBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -2673,7 +2673,7 @@ class NewFloatingBulkBpsPrice < Orb::Internal::Type::BaseModel class BulkBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume # # @return [Array] required :tiers, @@ -2753,7 +2753,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2796,7 +2796,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2862,21 +2862,21 @@ class NewFloatingBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2897,7 +2897,7 @@ class NewFloatingBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2910,7 +2910,7 @@ class NewFloatingBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2919,8 +2919,8 @@ class NewFloatingBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -3041,7 +3041,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -3084,7 +3084,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3149,21 +3149,21 @@ class NewFloatingThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3184,7 +3184,7 @@ class NewFloatingThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3197,7 +3197,7 @@ class NewFloatingThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3206,8 +3206,8 @@ class NewFloatingThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -3289,7 +3289,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] @@ -3332,7 +3332,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3397,21 +3397,21 @@ class NewFloatingTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3432,7 +3432,7 @@ class NewFloatingTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3445,7 +3445,7 @@ class NewFloatingTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3454,8 +3454,8 @@ class NewFloatingTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -3537,7 +3537,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -3580,7 +3580,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -3645,21 +3645,21 @@ class NewFloatingGroupedTieredPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3680,7 +3680,7 @@ class NewFloatingGroupedTieredPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3693,7 +3693,7 @@ class NewFloatingGroupedTieredPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3702,8 +3702,8 @@ class NewFloatingGroupedTieredPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -3785,7 +3785,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit] @@ -3828,7 +3828,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3894,21 +3894,21 @@ class NewFloatingMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3929,7 +3929,7 @@ class NewFloatingMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3942,7 +3942,7 @@ class NewFloatingMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3951,8 +3951,8 @@ class NewFloatingMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -4034,7 +4034,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -4077,7 +4077,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -4142,21 +4142,21 @@ class NewFloatingTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4177,7 +4177,7 @@ class NewFloatingTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4190,7 +4190,7 @@ class NewFloatingTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4199,8 +4199,8 @@ class NewFloatingTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -4282,7 +4282,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -4325,7 +4325,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4391,21 +4391,21 @@ class NewFloatingPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4426,7 +4426,7 @@ class NewFloatingPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4439,7 +4439,7 @@ class NewFloatingPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4448,8 +4448,8 @@ class NewFloatingPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -4531,7 +4531,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -4574,7 +4574,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4640,21 +4640,21 @@ class NewFloatingTieredPackageWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4675,7 +4675,7 @@ class NewFloatingTieredPackageWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4688,7 +4688,7 @@ class NewFloatingTieredPackageWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4697,8 +4697,8 @@ class NewFloatingTieredPackageWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -4780,7 +4780,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -4823,7 +4823,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4888,21 +4888,21 @@ class NewFloatingUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4923,7 +4923,7 @@ class NewFloatingUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4936,7 +4936,7 @@ class NewFloatingUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4945,8 +4945,8 @@ class NewFloatingUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -5028,7 +5028,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] @@ -5071,7 +5071,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5136,21 +5136,21 @@ class NewFloatingTieredWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5171,7 +5171,7 @@ class NewFloatingTieredWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5184,7 +5184,7 @@ class NewFloatingTieredWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5193,8 +5193,8 @@ class NewFloatingTieredWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -5276,7 +5276,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -5319,7 +5319,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5384,21 +5384,21 @@ class NewFloatingUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5419,7 +5419,7 @@ class NewFloatingUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5432,7 +5432,7 @@ class NewFloatingUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5441,8 +5441,8 @@ class NewFloatingUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -5524,7 +5524,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -5567,7 +5567,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5632,21 +5632,21 @@ class NewFloatingGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5667,7 +5667,7 @@ class NewFloatingGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5680,7 +5680,7 @@ class NewFloatingGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5689,8 +5689,8 @@ class NewFloatingGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -5772,7 +5772,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -5815,7 +5815,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5881,21 +5881,21 @@ class NewFloatingGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseMode # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5916,7 +5916,7 @@ class NewFloatingGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseMode # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5929,7 +5929,7 @@ class NewFloatingGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseMode # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5938,8 +5938,8 @@ class NewFloatingGroupedWithProratedMinimumPrice < Orb::Internal::Type::BaseMode # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -6021,7 +6021,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -6064,7 +6064,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6130,21 +6130,21 @@ class NewFloatingGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6165,7 +6165,7 @@ class NewFloatingGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6178,7 +6178,7 @@ class NewFloatingGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6187,8 +6187,8 @@ class NewFloatingGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -6270,7 +6270,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -6313,7 +6313,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6379,21 +6379,21 @@ class NewFloatingMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6414,7 +6414,7 @@ class NewFloatingMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6427,7 +6427,7 @@ class NewFloatingMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6436,8 +6436,8 @@ class NewFloatingMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -6519,7 +6519,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] @@ -6562,7 +6562,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] @@ -6627,21 +6627,21 @@ class NewFloatingBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6662,7 +6662,7 @@ class NewFloatingBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6675,7 +6675,7 @@ class NewFloatingBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6684,8 +6684,8 @@ class NewFloatingBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -6767,7 +6767,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -6810,7 +6810,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6875,21 +6875,21 @@ class NewFloatingGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6910,7 +6910,7 @@ class NewFloatingGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6923,7 +6923,7 @@ class NewFloatingGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6932,8 +6932,8 @@ class NewFloatingGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -7015,7 +7015,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -7058,7 +7058,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -7124,21 +7124,21 @@ class NewFloatingScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseM # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -7159,7 +7159,7 @@ class NewFloatingScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseM # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -7172,7 +7172,7 @@ class NewFloatingScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseM # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -7181,8 +7181,8 @@ class NewFloatingScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::BaseM # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -7264,7 +7264,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -7307,7 +7307,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -7373,21 +7373,21 @@ class NewFloatingScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::Bas # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -7408,7 +7408,7 @@ class NewFloatingScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::Bas # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -7421,7 +7421,7 @@ class NewFloatingScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::Bas # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -7430,8 +7430,8 @@ class NewFloatingScalableMatrixWithTieredPricingPrice < Orb::Internal::Type::Bas # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -7513,7 +7513,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -7556,7 +7556,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -7622,21 +7622,21 @@ class NewFloatingCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -7657,7 +7657,7 @@ class NewFloatingCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -7670,7 +7670,7 @@ class NewFloatingCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -7679,8 +7679,8 @@ class NewFloatingCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true @@ -7762,7 +7762,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -7805,7 +7805,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -7848,9 +7848,9 @@ class AddAdjustment < Orb::Internal::Type::BaseModel # @!attribute start_date # The start date of the adjustment interval. This is the date that the adjustment - # will start affecting prices on the subscription. The adjustment will apply to - # invoice dates that overlap with this `start_date`. This `start_date` is treated - # as inclusive for in-advance prices, and exclusive for in-arrears prices. + # will start affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `start_date`. This `start_date` is treated + # as inclusive for in-advance prices, and exclusive for in-arrears prices. # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate] required :start_date, @@ -7858,9 +7858,9 @@ class AddAdjustment < Orb::Internal::Type::BaseModel # @!attribute end_date # The end date of the adjustment interval. This is the date that the adjustment - # will stop affecting prices on the subscription. The adjustment will apply to - # invoice dates that overlap with this `end_date`.This `end_date` is treated as - # exclusive for in-advance prices, and inclusive for in-arrears prices. + # will stop affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `end_date`.This `end_date` is treated as + # exclusive for in-advance prices, and inclusive for in-arrears prices. # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] optional :end_date, @@ -7918,7 +7918,7 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -7965,7 +7965,7 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -8004,7 +8004,7 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -8049,7 +8049,7 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -8089,7 +8089,7 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -8115,9 +8115,9 @@ class NewMaximum < Orb::Internal::Type::BaseModel end # The start date of the adjustment interval. This is the date that the adjustment - # will start affecting prices on the subscription. The adjustment will apply to - # invoice dates that overlap with this `start_date`. This `start_date` is treated - # as inclusive for in-advance prices, and exclusive for in-arrears prices. + # will start affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `start_date`. This `start_date` is treated + # as inclusive for in-advance prices, and exclusive for in-arrears prices. # # @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#start_date module StartDate @@ -8133,9 +8133,9 @@ module StartDate end # The end date of the adjustment interval. This is the date that the adjustment - # will stop affecting prices on the subscription. The adjustment will apply to - # invoice dates that overlap with this `end_date`.This `end_date` is treated as - # exclusive for in-advance prices, and inclusive for in-arrears prices. + # will stop affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `end_date`.This `end_date` is treated as + # exclusive for in-advance prices, and inclusive for in-arrears prices. # # @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#end_date module EndDate @@ -8160,32 +8160,32 @@ class Edit < Orb::Internal::Type::BaseModel # @!attribute billing_cycle_day # The updated billing cycle day for this price interval. If not specified, the - # billing cycle day will not be updated. Note that overlapping price intervals - # must have the same billing cycle day. + # billing cycle day will not be updated. Note that overlapping price intervals + # must have the same billing cycle day. # # @return [Integer, nil] optional :billing_cycle_day, Integer, nil?: true # @!attribute end_date # The updated end date of this price interval. If not specified, the start date - # will not be updated. + # will not be updated. # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] optional :end_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::Edit::EndDate }, nil?: true # @!attribute filter # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. # # @return [String, nil] optional :filter, String, nil?: true # @!attribute fixed_fee_quantity_transitions # A list of fixed fee quantity transitions to use for this price interval. Note - # that this list will overwrite all existing fixed fee quantity transitions on the - # price interval. + # that this list will overwrite all existing fixed fee quantity transitions on the + # price interval. # # @return [Array, nil] optional :fixed_fee_quantity_transitions, @@ -8194,7 +8194,7 @@ class Edit < Orb::Internal::Type::BaseModel # @!attribute [r] start_date # The updated start date of this price interval. If not specified, the start date - # will not be updated. + # will not be updated. # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] optional :start_date, union: -> { Orb::Models::SubscriptionPriceIntervalsParams::Edit::StartDate } @@ -8205,11 +8205,11 @@ class Edit < Orb::Internal::Type::BaseModel # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. # # @return [Array, nil] optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true @@ -8239,7 +8239,7 @@ class Edit < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void # The updated end date of this price interval. If not specified, the start date - # will not be updated. + # will not be updated. # # @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#end_date module EndDate @@ -8277,7 +8277,7 @@ class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel end # The updated start date of this price interval. If not specified, the start date - # will not be updated. + # will not be updated. # # @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#start_date module StartDate @@ -8302,7 +8302,7 @@ class EditAdjustment < Orb::Internal::Type::BaseModel # @!attribute end_date # The updated end date of this adjustment interval. If not specified, the start - # date will not be updated. + # date will not be updated. # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] optional :end_date, @@ -8311,7 +8311,7 @@ class EditAdjustment < Orb::Internal::Type::BaseModel # @!attribute [r] start_date # The updated start date of this adjustment interval. If not specified, the start - # date will not be updated. + # date will not be updated. # # @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] optional :start_date, @@ -8331,7 +8331,7 @@ class EditAdjustment < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void # The updated end date of this adjustment interval. If not specified, the start - # date will not be updated. + # date will not be updated. # # @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#end_date module EndDate @@ -8347,7 +8347,7 @@ module EndDate end # The updated start date of this adjustment interval. If not specified, the start - # date will not be updated. + # date will not be updated. # # @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#start_date module StartDate diff --git a/lib/orb/models/subscription_price_intervals_response.rb b/lib/orb/models/subscription_price_intervals_response.rb index 628fa5b1..a682ff8b 100644 --- a/lib/orb/models/subscription_price_intervals_response.rb +++ b/lib/orb/models/subscription_price_intervals_response.rb @@ -11,14 +11,14 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -334,7 +334,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -353,7 +353,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -396,7 +396,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -409,7 +409,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -470,14 +470,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -538,7 +538,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -551,7 +551,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -614,14 +614,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -673,24 +673,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -804,7 +804,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -870,7 +870,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -956,7 +956,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -1000,7 +1000,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1037,23 +1037,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1066,7 +1066,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1075,37 +1075,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] diff --git a/lib/orb/models/subscription_schedule_plan_change_params.rb b/lib/orb/models/subscription_schedule_plan_change_params.rb index 69c4ab44..9b6f2d98 100644 --- a/lib/orb/models/subscription_schedule_plan_change_params.rb +++ b/lib/orb/models/subscription_schedule_plan_change_params.rb @@ -15,7 +15,7 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute add_adjustments # Additional adjustments to be added to the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :add_adjustments, @@ -24,7 +24,7 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute add_prices # Additional prices to be added to the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :add_prices, @@ -33,23 +33,23 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute align_billing_with_plan_change_date # [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be - # aligned with the plan change's effective date. + # aligned with the plan change's effective date. # # @return [Boolean, nil] optional :align_billing_with_plan_change_date, Orb::Internal::Type::Boolean, nil?: true # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. If not specified, this - # defaults to the behavior configured for this customer. + # charged with the saved payment method on the due date. If not specified, this + # defaults to the behavior configured for this customer. # # @return [Boolean, nil] optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_alignment # Reset billing periods to be aligned with the plan change's effective date or - # start of the month. Defaults to `unchanged` which keeps subscription's existing - # billing cycle alignment. + # start of the month. Defaults to `unchanged` which keeps subscription's existing + # billing cycle alignment. # # @return [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment, nil] optional :billing_cycle_alignment, @@ -65,16 +65,16 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute change_date # The date that the plan change should take effect. This parameter can only be - # passed if the `change_option` is `requested_date`. If a date with no time is - # passed, the plan change will happen at midnight in the customer's timezone. + # passed if the `change_option` is `requested_date`. If a date with no time is + # passed, the plan change will happen at midnight in the customer's timezone. # # @return [Time, nil] optional :change_date, Time, nil?: true # @!attribute coupon_redemption_code # Redemption code to be used for this subscription. If the coupon cannot be found - # by its redemption code, or cannot be redeemed, an error response will be - # returned and the subscription creation or plan change will not be scheduled. + # by its redemption code, or cannot be redeemed, an error response will be + # returned and the subscription creation or plan change will not be scheduled. # # @return [String, nil] optional :coupon_redemption_code, String, nil?: true @@ -86,23 +86,23 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute default_invoice_memo # Determines the default memo on this subscription's invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] optional :default_invoice_memo, String, nil?: true # @!attribute external_plan_id # The external_plan_id of the plan that the given subscription should be switched - # to. Note that either this property or `plan_id` must be specified. + # to. Note that either this property or `plan_id` must be specified. # # @return [String, nil] optional :external_plan_id, String, nil?: true # @!attribute filter # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. # # @return [String, nil] optional :filter, String, nil?: true @@ -115,16 +115,16 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute invoicing_threshold # When this subscription's accrued usage reaches this threshold, an invoice will - # be issued for the subscription. If not specified, invoices will only be issued - # at the end of the billing period. + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. # # @return [String, nil] optional :invoicing_threshold, String, nil?: true # @!attribute net_terms # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. If not provided, this defaults to the value specified in the plan. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. If not provided, this defaults to the value specified in the plan. # # @return [Integer, nil] optional :net_terms, Integer, nil?: true @@ -136,14 +136,14 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute plan_id # The plan that the given subscription should be switched to. Note that either - # this property or `external_plan_id` must be specified. + # this property or `external_plan_id` must be specified. # # @return [String, nil] optional :plan_id, String, nil?: true # @!attribute plan_version_number # Specifies which version of the plan to change to. If null, the default version - # will be used. + # will be used. # # @return [Integer, nil] optional :plan_version_number, Integer, nil?: true @@ -156,7 +156,7 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute remove_adjustments # Plan adjustments to be removed from the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :remove_adjustments, @@ -165,7 +165,7 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute remove_prices # Plan prices to be removed from the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :remove_prices, @@ -174,8 +174,8 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute replace_adjustments # Plan adjustments to be replaced with additional adjustments on the subscription. - # (Only available for accounts that have migrated off of legacy subscription - # overrides) + # (Only available for accounts that have migrated off of legacy subscription + # overrides) # # @return [Array, nil] optional :replace_adjustments, @@ -184,7 +184,7 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute replace_prices # Plan prices to be replaced with additional prices on the subscription. (Only - # available for accounts that have migrated off of legacy subscription overrides) + # available for accounts that have migrated off of legacy subscription overrides) # # @return [Array, nil] optional :replace_prices, @@ -193,19 +193,19 @@ class SubscriptionSchedulePlanChangeParams < Orb::Internal::Type::BaseModel # @!attribute trial_duration_days # The duration of the trial period in days. If not provided, this defaults to the - # value specified in the plan. If `0` is provided, the trial on the plan will be - # skipped. + # value specified in the plan. If `0` is provided, the trial on the plan will be + # skipped. # # @return [Integer, nil] optional :trial_duration_days, Integer, nil?: true # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. # # @return [Array, nil] optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true @@ -298,7 +298,7 @@ class AddAdjustment < Orb::Internal::Type::BaseModel # @!attribute end_date # The end date of the adjustment interval. This is the date that the adjustment - # will stop affecting prices on the subscription. + # will stop affecting prices on the subscription. # # @return [Time, nil] optional :end_date, Time, nil?: true @@ -311,8 +311,8 @@ class AddAdjustment < Orb::Internal::Type::BaseModel # @!attribute start_date # The start date of the adjustment interval. This is the date that the adjustment - # will start affecting prices on the subscription. If null, the adjustment will - # start when the phase or subscription starts. + # will start affecting prices on the subscription. If null, the adjustment will + # start when the phase or subscription starts. # # @return [Time, nil] optional :start_date, Time, nil?: true @@ -369,7 +369,7 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -416,7 +416,7 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -455,7 +455,7 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -500,7 +500,7 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -540,7 +540,7 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -577,7 +577,7 @@ class AddPrice < Orb::Internal::Type::BaseModel # @!attribute discounts # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this - # price. + # price. # # @return [Array, nil] optional :discounts, @@ -586,8 +586,8 @@ class AddPrice < Orb::Internal::Type::BaseModel # @!attribute end_date # The end date of the price interval. This is the date that the price will stop - # billing on the subscription. If null, billing will end when the phase or - # subscription ends. + # billing on the subscription. If null, billing will end when the phase or + # subscription ends. # # @return [Time, nil] optional :end_date, Time, nil?: true @@ -600,14 +600,14 @@ class AddPrice < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for - # this price. + # this price. # # @return [String, nil] optional :maximum_amount, String, nil?: true # @!attribute minimum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for - # this price. + # this price. # # @return [String, nil] optional :minimum_amount, String, nil?: true @@ -634,8 +634,8 @@ class AddPrice < Orb::Internal::Type::BaseModel # @!attribute start_date # The start date of the price interval. This is the date that the price will start - # billing on the subscription. If null, billing will start when the phase or - # subscription starts. + # billing on the subscription. If null, billing will start when the phase or + # subscription starts. # # @return [Time, nil] optional :start_date, Time, nil?: true @@ -687,14 +687,14 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. # # @return [String] required :currency, String # @!attribute expires_at_end_of_cadence # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. # # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean @@ -747,14 +747,14 @@ class Discount < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. # # @return [Float, nil] optional :percentage_discount, Float, nil?: true # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float, nil] optional :usage_discount, Float, nil?: true @@ -901,21 +901,21 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -930,7 +930,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -943,7 +943,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -956,7 +956,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -965,15 +965,15 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -1073,7 +1073,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] @@ -1116,7 +1116,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1176,21 +1176,21 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1205,7 +1205,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1218,7 +1218,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1231,7 +1231,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1240,15 +1240,15 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -1325,7 +1325,7 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @!attribute package_size # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating # # @return [Integer] required :package_size, Integer @@ -1356,7 +1356,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -1399,7 +1399,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -1459,21 +1459,21 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1488,7 +1488,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1501,7 +1501,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1514,7 +1514,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1523,15 +1523,15 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -1635,8 +1635,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -1674,7 +1674,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] @@ -1717,7 +1717,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] @@ -1777,21 +1777,21 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -1806,7 +1806,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -1819,7 +1819,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -1832,7 +1832,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -1841,15 +1841,15 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -1983,7 +1983,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] @@ -2026,7 +2026,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2086,21 +2086,21 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2115,7 +2115,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -2128,7 +2128,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2141,7 +2141,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2150,15 +2150,15 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -2229,7 +2229,7 @@ module Cadence class TieredBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers # # @return [Array] required :tiers, @@ -2300,7 +2300,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2343,7 +2343,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2403,21 +2403,21 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2432,7 +2432,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -2445,7 +2445,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2458,7 +2458,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2467,15 +2467,15 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -2582,7 +2582,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2625,7 +2625,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2685,21 +2685,21 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -2714,7 +2714,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -2727,7 +2727,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -2740,7 +2740,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -2749,15 +2749,15 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -2808,7 +2808,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel class BulkBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume # # @return [Array] required :tiers, @@ -2892,7 +2892,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -2935,7 +2935,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -2995,21 +2995,21 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3024,7 +3024,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3037,7 +3037,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3050,7 +3050,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3059,15 +3059,15 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -3194,7 +3194,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -3237,7 +3237,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3296,21 +3296,21 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3325,7 +3325,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3338,7 +3338,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3351,7 +3351,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3360,15 +3360,15 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -3452,7 +3452,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] @@ -3495,7 +3495,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] @@ -3554,21 +3554,21 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3583,7 +3583,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3596,7 +3596,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3609,7 +3609,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3618,15 +3618,15 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -3710,7 +3710,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -3753,7 +3753,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -3812,21 +3812,21 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -3841,7 +3841,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -3854,7 +3854,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -3867,7 +3867,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -3876,15 +3876,15 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -3968,7 +3968,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -4011,7 +4011,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4070,21 +4070,21 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4099,7 +4099,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4112,7 +4112,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4125,7 +4125,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4134,15 +4134,15 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -4226,7 +4226,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] @@ -4269,7 +4269,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4329,21 +4329,21 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4358,7 +4358,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4371,7 +4371,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4384,7 +4384,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4393,15 +4393,15 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -4485,7 +4485,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -4528,7 +4528,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4587,21 +4587,21 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4616,7 +4616,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4629,7 +4629,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4642,7 +4642,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4651,15 +4651,15 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -4743,7 +4743,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -4786,7 +4786,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -4845,21 +4845,21 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -4874,7 +4874,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -4887,7 +4887,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -4900,7 +4900,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -4909,15 +4909,15 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -5001,7 +5001,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -5044,7 +5044,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5103,21 +5103,21 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5132,7 +5132,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5145,7 +5145,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5158,7 +5158,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5167,15 +5167,15 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -5259,7 +5259,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -5302,7 +5302,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5362,21 +5362,21 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5391,7 +5391,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5404,7 +5404,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5417,7 +5417,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5426,15 +5426,15 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -5518,7 +5518,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -5561,7 +5561,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5620,21 +5620,21 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5649,7 +5649,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5662,7 +5662,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5675,7 +5675,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5684,15 +5684,15 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -5776,7 +5776,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -5819,7 +5819,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -5879,21 +5879,21 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -5908,7 +5908,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -5921,7 +5921,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -5934,7 +5934,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -5943,15 +5943,15 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -6035,7 +6035,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -6078,7 +6078,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6138,21 +6138,21 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6167,7 +6167,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6180,7 +6180,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6193,7 +6193,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6202,15 +6202,15 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -6294,7 +6294,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -6337,7 +6337,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6397,21 +6397,21 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6426,7 +6426,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6439,7 +6439,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6452,7 +6452,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6461,15 +6461,15 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -6553,7 +6553,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -6596,7 +6596,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -6656,21 +6656,21 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6685,7 +6685,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6698,7 +6698,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6711,7 +6711,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6720,15 +6720,15 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -6812,7 +6812,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -6855,7 +6855,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -6915,21 +6915,21 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -6944,7 +6944,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -6957,7 +6957,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -6970,7 +6970,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -6979,15 +6979,15 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -7071,7 +7071,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -7114,7 +7114,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -7174,21 +7174,21 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -7203,7 +7203,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -7216,7 +7216,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -7229,7 +7229,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -7238,15 +7238,15 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -7330,7 +7330,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] @@ -7373,7 +7373,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] @@ -7432,21 +7432,21 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -7461,7 +7461,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -7474,7 +7474,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -7487,7 +7487,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -7496,15 +7496,15 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -7588,7 +7588,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -7631,7 +7631,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -7665,8 +7665,8 @@ module DurationUnit end # Reset billing periods to be aligned with the plan change's effective date or - # start of the month. Defaults to `unchanged` which keeps subscription's existing - # billing cycle alignment. + # start of the month. Defaults to `unchanged` which keeps subscription's existing + # billing cycle alignment. module BillingCycleAlignment extend Orb::Internal::Type::Enum @@ -7684,24 +7684,24 @@ module BillingCycleAlignment class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -7817,7 +7817,7 @@ class NewPercentageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -7864,7 +7864,7 @@ class NewUsageDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -7903,7 +7903,7 @@ class NewAmountDiscount < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -7948,7 +7948,7 @@ class NewMinimum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -7988,7 +7988,7 @@ class NewMaximum < Orb::Internal::Type::BaseModel # @!attribute [r] is_invoice_level # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. # # @return [Boolean, nil] optional :is_invoice_level, Orb::Internal::Type::Boolean @@ -8031,7 +8031,7 @@ class ReplacePrice < Orb::Internal::Type::BaseModel # @!attribute discounts # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the - # replacement price. + # replacement price. # # @return [Array, nil] optional :discounts, @@ -8052,14 +8052,14 @@ class ReplacePrice < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for - # the replacement price. + # the replacement price. # # @return [String, nil] optional :maximum_amount, String, nil?: true # @!attribute minimum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for - # the replacement price. + # the replacement price. # # @return [String, nil] optional :minimum_amount, String, nil?: true @@ -8123,14 +8123,14 @@ class AllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. # # @return [String] required :currency, String # @!attribute expires_at_end_of_cadence # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. # # @return [Boolean] required :expires_at_end_of_cadence, Orb::Internal::Type::Boolean @@ -8183,14 +8183,14 @@ class Discount < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. # # @return [Float, nil] optional :percentage_discount, Float, nil?: true # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float, nil] optional :usage_discount, Float, nil?: true @@ -8337,21 +8337,21 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -8366,7 +8366,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -8379,7 +8379,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -8392,7 +8392,7 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -8401,15 +8401,15 @@ class NewSubscriptionUnitPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -8509,7 +8509,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit] @@ -8552,7 +8552,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit] @@ -8612,21 +8612,21 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -8641,7 +8641,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -8654,7 +8654,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -8667,7 +8667,7 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -8676,15 +8676,15 @@ class NewSubscriptionPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -8761,7 +8761,7 @@ class PackageConfig < Orb::Internal::Type::BaseModel # @!attribute package_size # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating # # @return [Integer] required :package_size, Integer @@ -8792,7 +8792,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -8835,7 +8835,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -8895,21 +8895,21 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -8924,7 +8924,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -8937,7 +8937,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -8950,7 +8950,7 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -8959,15 +8959,15 @@ class NewSubscriptionMatrixPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -9071,8 +9071,8 @@ class MatrixConfig < Orb::Internal::Type::BaseModel class MatrixValue < Orb::Internal::Type::BaseModel # @!attribute dimension_values # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. # # @return [Array] required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true] @@ -9110,7 +9110,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit] @@ -9153,7 +9153,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit] @@ -9213,21 +9213,21 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -9242,7 +9242,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -9255,7 +9255,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -9268,7 +9268,7 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -9277,15 +9277,15 @@ class NewSubscriptionTieredPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -9419,7 +9419,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit] @@ -9462,7 +9462,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit] @@ -9522,21 +9522,21 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -9551,7 +9551,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -9564,7 +9564,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -9577,7 +9577,7 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -9586,15 +9586,15 @@ class NewSubscriptionTieredBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -9665,7 +9665,7 @@ module Cadence class TieredBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers # # @return [Array] required :tiers, @@ -9736,7 +9736,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -9779,7 +9779,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -9839,21 +9839,21 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -9868,7 +9868,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -9881,7 +9881,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -9894,7 +9894,7 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -9903,15 +9903,15 @@ class NewSubscriptionBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -10018,7 +10018,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -10061,7 +10061,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -10121,21 +10121,21 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -10150,7 +10150,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -10163,7 +10163,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -10176,7 +10176,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -10185,15 +10185,15 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -10244,7 +10244,7 @@ class NewSubscriptionBulkBpsPrice < Orb::Internal::Type::BaseModel class BulkBpsConfig < Orb::Internal::Type::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume # # @return [Array] required :tiers, @@ -10328,7 +10328,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit] @@ -10371,7 +10371,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit] @@ -10431,21 +10431,21 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -10460,7 +10460,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -10473,7 +10473,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -10486,7 +10486,7 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -10495,15 +10495,15 @@ class NewSubscriptionBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -10630,7 +10630,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -10673,7 +10673,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -10732,21 +10732,21 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -10761,7 +10761,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -10774,7 +10774,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -10787,7 +10787,7 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -10796,15 +10796,15 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -10888,7 +10888,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit] @@ -10931,7 +10931,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit] @@ -10990,21 +10990,21 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -11019,7 +11019,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -11032,7 +11032,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -11045,7 +11045,7 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -11054,15 +11054,15 @@ class NewSubscriptionTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -11146,7 +11146,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -11189,7 +11189,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -11248,21 +11248,21 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -11277,7 +11277,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -11290,7 +11290,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -11303,7 +11303,7 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -11312,15 +11312,15 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -11404,7 +11404,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -11447,7 +11447,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -11506,21 +11506,21 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -11535,7 +11535,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -11548,7 +11548,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -11561,7 +11561,7 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -11570,15 +11570,15 @@ class NewSubscriptionUnitWithPercentPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -11662,7 +11662,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit] @@ -11705,7 +11705,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit] @@ -11765,21 +11765,21 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -11794,7 +11794,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -11807,7 +11807,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -11820,7 +11820,7 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -11829,15 +11829,15 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -11921,7 +11921,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -11964,7 +11964,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -12023,21 +12023,21 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -12052,7 +12052,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -12065,7 +12065,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -12078,7 +12078,7 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -12087,15 +12087,15 @@ class NewSubscriptionTierWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -12179,7 +12179,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -12222,7 +12222,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -12281,21 +12281,21 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -12310,7 +12310,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -12323,7 +12323,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -12336,7 +12336,7 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -12345,15 +12345,15 @@ class NewSubscriptionUnitWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -12437,7 +12437,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -12480,7 +12480,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -12539,21 +12539,21 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -12568,7 +12568,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -12581,7 +12581,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -12594,7 +12594,7 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -12603,15 +12603,15 @@ class NewSubscriptionGroupedAllocationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -12695,7 +12695,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit] @@ -12738,7 +12738,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -12798,21 +12798,21 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -12827,7 +12827,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -12840,7 +12840,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -12853,7 +12853,7 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -12862,15 +12862,15 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::Internal::Type::Base # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -12954,7 +12954,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -12997,7 +12997,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -13056,21 +13056,21 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -13085,7 +13085,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -13098,7 +13098,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -13111,7 +13111,7 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -13120,15 +13120,15 @@ class NewSubscriptionBulkWithProrationPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -13212,7 +13212,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit] @@ -13255,7 +13255,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit] @@ -13315,21 +13315,21 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -13344,7 +13344,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -13357,7 +13357,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -13370,7 +13370,7 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -13379,15 +13379,15 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::Internal::Type::B # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -13471,7 +13471,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -13514,7 +13514,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -13574,21 +13574,21 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -13603,7 +13603,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -13616,7 +13616,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -13629,7 +13629,7 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -13638,15 +13638,15 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::Internal::Type: # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -13730,7 +13730,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit] @@ -13773,7 +13773,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit] @@ -13833,21 +13833,21 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -13862,7 +13862,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -13875,7 +13875,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -13888,7 +13888,7 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -13897,15 +13897,15 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -13989,7 +13989,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit] @@ -14032,7 +14032,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit] @@ -14092,21 +14092,21 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -14121,7 +14121,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -14134,7 +14134,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -14147,7 +14147,7 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -14156,15 +14156,15 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -14248,7 +14248,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -14291,7 +14291,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] @@ -14351,21 +14351,21 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -14380,7 +14380,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -14393,7 +14393,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -14406,7 +14406,7 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -14415,15 +14415,15 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::Internal::Type::BaseM # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -14507,7 +14507,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit] @@ -14550,7 +14550,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit] @@ -14610,21 +14610,21 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -14639,7 +14639,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -14652,7 +14652,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -14665,7 +14665,7 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -14674,15 +14674,15 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -14766,7 +14766,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit] @@ -14809,7 +14809,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit] @@ -14868,21 +14868,21 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute billable_metric_id # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. # # @return [String, nil] optional :billable_metric_id, String, nil?: true # @!attribute billed_in_advance # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. # # @return [Boolean, nil] optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true # @!attribute billing_cycle_configuration # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration, nil] optional :billing_cycle_configuration, @@ -14897,7 +14897,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute currency # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. # # @return [String, nil] optional :currency, String, nil?: true @@ -14910,7 +14910,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute fixed_price_quantity # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. # # @return [Float, nil] optional :fixed_price_quantity, Float, nil?: true @@ -14923,7 +14923,7 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute invoicing_cycle_configuration # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. # # @return [Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil] optional :invoicing_cycle_configuration, @@ -14932,15 +14932,15 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::Internal::Type::BaseModel # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute reference_id # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. # # @return [String, nil] optional :reference_id, String, nil?: true @@ -15024,7 +15024,7 @@ class BillingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # For custom cadence: specifies the duration of the billing period in days or - # # months. + # # months. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit] @@ -15067,7 +15067,7 @@ class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel # @!parse # # Within each billing cycle, specifies the cadence at which invoices are produced. - # # If unspecified, a single invoice is produced per billing cycle. + # # If unspecified, a single invoice is produced per billing cycle. # # # # @param duration [Integer] # # @param duration_unit [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit] diff --git a/lib/orb/models/subscription_schedule_plan_change_response.rb b/lib/orb/models/subscription_schedule_plan_change_response.rb index 2946223e..ef4d3be2 100644 --- a/lib/orb/models/subscription_schedule_plan_change_response.rb +++ b/lib/orb/models/subscription_schedule_plan_change_response.rb @@ -11,14 +11,14 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -334,7 +334,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -353,7 +353,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -396,7 +396,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -409,7 +409,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -470,14 +470,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -538,7 +538,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -551,7 +551,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -614,14 +614,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -673,24 +673,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -804,7 +804,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -870,7 +870,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -956,7 +956,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -1000,7 +1000,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1037,23 +1037,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1066,7 +1066,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1075,37 +1075,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] diff --git a/lib/orb/models/subscription_trigger_phase_params.rb b/lib/orb/models/subscription_trigger_phase_params.rb index 9862701f..166abf03 100644 --- a/lib/orb/models/subscription_trigger_phase_params.rb +++ b/lib/orb/models/subscription_trigger_phase_params.rb @@ -10,15 +10,15 @@ class SubscriptionTriggerPhaseParams < Orb::Internal::Type::BaseModel # @!attribute allow_invoice_credit_or_void # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. # # @return [Boolean, nil] optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true # @!attribute effective_date # The date on which the phase change should take effect. If not provided, defaults - # to today in the customer's timezone. + # to today in the customer's timezone. # # @return [Date, nil] optional :effective_date, Date, nil?: true diff --git a/lib/orb/models/subscription_trigger_phase_response.rb b/lib/orb/models/subscription_trigger_phase_response.rb index 8f576ec9..1c75dd62 100644 --- a/lib/orb/models/subscription_trigger_phase_response.rb +++ b/lib/orb/models/subscription_trigger_phase_response.rb @@ -11,14 +11,14 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -334,7 +334,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -353,7 +353,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -396,7 +396,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -409,7 +409,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -470,14 +470,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -538,7 +538,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -551,7 +551,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -614,14 +614,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -673,24 +673,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -804,7 +804,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -870,7 +870,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -956,7 +956,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -1000,7 +1000,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1037,23 +1037,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1066,7 +1066,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1075,37 +1075,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] diff --git a/lib/orb/models/subscription_unschedule_cancellation_response.rb b/lib/orb/models/subscription_unschedule_cancellation_response.rb index 2acefbe1..e1ad002e 100644 --- a/lib/orb/models/subscription_unschedule_cancellation_response.rb +++ b/lib/orb/models/subscription_unschedule_cancellation_response.rb @@ -11,14 +11,14 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -334,7 +334,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -353,7 +353,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -396,7 +396,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -409,7 +409,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -470,14 +470,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -538,7 +538,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -551,7 +551,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -614,14 +614,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -673,24 +673,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -804,7 +804,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -870,7 +870,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -956,7 +956,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -1000,7 +1000,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1037,23 +1037,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1066,7 +1066,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1075,37 +1075,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] 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 e91deff9..c558c121 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 @@ -11,14 +11,14 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -334,7 +334,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -353,7 +353,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -396,7 +396,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -409,7 +409,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -470,14 +470,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -538,7 +538,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -551,7 +551,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -614,14 +614,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -673,24 +673,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -804,7 +804,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -870,7 +870,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -956,7 +956,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -1000,7 +1000,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1037,23 +1037,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1066,7 +1066,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1079,37 +1079,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] 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 f56f985e..b7b671e9 100644 --- a/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +++ b/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb @@ -11,14 +11,14 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -334,7 +334,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -353,7 +353,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -396,7 +396,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -409,7 +409,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -470,14 +470,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -538,7 +538,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -551,7 +551,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -614,14 +614,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -673,24 +673,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -804,7 +804,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -870,7 +870,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -956,7 +956,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -1000,7 +1000,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1037,23 +1037,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1066,7 +1066,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1075,37 +1075,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] diff --git a/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb b/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb index 8df8185f..99c55a37 100644 --- a/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +++ b/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb @@ -21,16 +21,16 @@ class SubscriptionUpdateFixedFeeQuantityParams < Orb::Internal::Type::BaseModel # @!attribute allow_invoice_credit_or_void # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. # # @return [Boolean, nil] optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true # @!attribute [r] change_option # Determines when the change takes effect. Note that if `effective_date` is - # specified, this defaults to `effective_date`. Otherwise, this defaults to - # `immediate` unless it's explicitly set to `upcoming_invoice`. + # specified, this defaults to `effective_date`. Otherwise, this defaults to + # `immediate` unless it's explicitly set to `upcoming_invoice`. # # @return [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption, nil] optional :change_option, enum: -> { Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption } @@ -41,8 +41,8 @@ class SubscriptionUpdateFixedFeeQuantityParams < Orb::Internal::Type::BaseModel # @!attribute effective_date # The date that the quantity change should take effect, localized to the - # customer's timezone. Ifthis parameter is not passed in, the quantity change is - # effective according to `change_option`. + # customer's timezone. Ifthis parameter is not passed in, the quantity change is + # effective according to `change_option`. # # @return [Date, nil] optional :effective_date, Date, nil?: true @@ -70,8 +70,8 @@ class SubscriptionUpdateFixedFeeQuantityParams < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void # Determines when the change takes effect. Note that if `effective_date` is - # specified, this defaults to `effective_date`. Otherwise, this defaults to - # `immediate` unless it's explicitly set to `upcoming_invoice`. + # specified, this defaults to `effective_date`. Otherwise, this defaults to + # `immediate` unless it's explicitly set to `upcoming_invoice`. module ChangeOption extend Orb::Internal::Type::Enum 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 bb8924f7..fc90be70 100644 --- a/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +++ b/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb @@ -11,14 +11,14 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -334,7 +334,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -353,7 +353,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -396,7 +396,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -409,7 +409,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -470,14 +470,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -538,7 +538,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -551,7 +551,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -614,14 +614,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -673,24 +673,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -804,7 +804,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -870,7 +870,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -956,7 +956,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -1000,7 +1000,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1037,23 +1037,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1066,7 +1066,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1075,37 +1075,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] diff --git a/lib/orb/models/subscription_update_params.rb b/lib/orb/models/subscription_update_params.rb index a891bfdd..5186bb9f 100644 --- a/lib/orb/models/subscription_update_params.rb +++ b/lib/orb/models/subscription_update_params.rb @@ -10,40 +10,40 @@ class SubscriptionUpdateParams < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. # # @return [Boolean, nil] optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true # @!attribute default_invoice_memo # Determines the default memo on this subscription's invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] optional :default_invoice_memo, String, nil?: true # @!attribute invoicing_threshold # When this subscription's accrued usage reaches this threshold, an invoice will - # be issued for the subscription. If not specified, invoices will only be issued - # at the end of the billing period. + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. # # @return [String, nil] optional :invoicing_threshold, String, nil?: true # @!attribute metadata # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. # # @return [Hash{Symbol=>String, nil}, nil] optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer, nil] optional :net_terms, Integer, nil?: true diff --git a/lib/orb/models/subscription_update_trial_params.rb b/lib/orb/models/subscription_update_trial_params.rb index 9a9a683b..665c1e95 100644 --- a/lib/orb/models/subscription_update_trial_params.rb +++ b/lib/orb/models/subscription_update_trial_params.rb @@ -10,14 +10,14 @@ class SubscriptionUpdateTrialParams < Orb::Internal::Type::BaseModel # @!attribute trial_end_date # The new date that the trial should end, or the literal string `immediate` to end - # the trial immediately. + # the trial immediately. # # @return [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] required :trial_end_date, union: -> { Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate } # @!attribute [r] shift # If true, shifts subsequent price and adjustment intervals (preserving their - # durations, but adjusting their absolute dates). + # durations, but adjusting their absolute dates). # # @return [Boolean, nil] optional :shift, Orb::Internal::Type::Boolean @@ -36,7 +36,7 @@ class SubscriptionUpdateTrialParams < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void # The new date that the trial should end, or the literal string `immediate` to end - # the trial immediately. + # the trial immediately. module TrialEndDate extend Orb::Internal::Type::Union diff --git a/lib/orb/models/subscription_update_trial_response.rb b/lib/orb/models/subscription_update_trial_response.rb index 6d643946..fc5dd2fe 100644 --- a/lib/orb/models/subscription_update_trial_response.rb +++ b/lib/orb/models/subscription_update_trial_response.rb @@ -11,14 +11,14 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # @!attribute active_plan_phase_order # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. # # @return [Integer, nil] required :active_plan_phase_order, Integer, nil?: true # @!attribute adjustment_intervals # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. # # @return [Array] required :adjustment_intervals, @@ -26,8 +26,8 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # @!attribute auto_collection # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. # # @return [Boolean, nil] required :auto_collection, Orb::Internal::Type::Boolean, nil?: true @@ -40,9 +40,9 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # @!attribute billing_cycle_day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :billing_cycle_day, Integer @@ -54,46 +54,46 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute customer # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. # # @return [Orb::Models::Customer] required :customer, -> { Orb::Models::Customer } # @!attribute default_invoice_memo # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. # # @return [String, nil] required :default_invoice_memo, String, nil?: true @@ -131,9 +131,9 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # @!attribute metadata # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. # # @return [Hash{Symbol=>String}] required :metadata, Orb::Internal::Type::HashOf[String] @@ -147,18 +147,18 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # @!attribute net_terms # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. # # @return [Integer] required :net_terms, Integer # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). # # @return [Orb::Models::Plan] required :plan, -> { Orb::Models::Plan } @@ -332,7 +332,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -351,7 +351,7 @@ class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute usage_discount # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. # # @return [Float] required :usage_discount, Float @@ -394,7 +394,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute amount_discount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. # # @return [String] required :amount_discount, String @@ -407,7 +407,7 @@ class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -468,14 +468,14 @@ class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute percentage_discount # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. # # @return [Float] required :percentage_discount, Float @@ -536,7 +536,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean @@ -549,7 +549,7 @@ class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :minimum_amount, String @@ -612,14 +612,14 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel # @!attribute is_invoice_level # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. # # @return [Boolean] required :is_invoice_level, Orb::Internal::Type::Boolean # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. # # @return [String] required :maximum_amount, String @@ -671,24 +671,24 @@ class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. # # @return [Integer] required :day, Integer # @!attribute month # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). # # @return [Integer, nil] optional :month, Integer, nil?: true # @!attribute year # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). # # @return [Integer, nil] optional :year, Integer, nil?: true @@ -802,7 +802,7 @@ class PercentageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute percentage_discount # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. # # @return [Float] required :percentage_discount, Float @@ -868,7 +868,7 @@ class UsageDiscountInterval < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float @@ -954,7 +954,7 @@ class MaximumInterval < Orb::Internal::Type::BaseModel # @!attribute maximum_amount # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. # # @return [String] required :maximum_amount, String @@ -998,7 +998,7 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # @!attribute minimum_amount # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. # # @return [String] required :minimum_amount, String @@ -1035,23 +1035,23 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute current_billing_period_end_date # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_end_date, Time, nil?: true # @!attribute current_billing_period_start_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. # # @return [Time, nil] required :current_billing_period_start_date, Time, nil?: true # @!attribute end_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. # # @return [Time, nil] required :end_date, Time, nil?: true @@ -1064,7 +1064,7 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute fixed_fee_quantity_transitions # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. # # @return [Array, nil] required :fixed_fee_quantity_transitions, @@ -1073,37 +1073,37 @@ class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute price # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] required :price, union: -> { Orb::Models::Price } # @!attribute start_date # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. # # @return [Time] required :start_date, Time # @!attribute usage_customer_ids # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. # # @return [Array, nil] required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true # @!parse # # The Price Interval resource represents a period of time for which a price will - # # bill on a subscription. A subscription’s price intervals define its billing - # # behavior. + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. # # # # @param id [String] # # @param billing_cycle_day [Integer] diff --git a/lib/orb/models/trial_discount.rb b/lib/orb/models/trial_discount.rb index 5fe9f635..df8a6de4 100644 --- a/lib/orb/models/trial_discount.rb +++ b/lib/orb/models/trial_discount.rb @@ -5,7 +5,7 @@ module Models class TrialDiscount < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this discount applies to. For plan/plan phase discounts, - # this can be a subset of prices. + # this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] diff --git a/lib/orb/models/usage_discount.rb b/lib/orb/models/usage_discount.rb index ddb47a95..c0c43ff3 100644 --- a/lib/orb/models/usage_discount.rb +++ b/lib/orb/models/usage_discount.rb @@ -5,7 +5,7 @@ module Models class UsageDiscount < Orb::Internal::Type::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this discount applies to. For plan/plan phase discounts, - # this can be a subset of prices. + # this can be a subset of prices. # # @return [Array] required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] @@ -17,7 +17,7 @@ class UsageDiscount < Orb::Internal::Type::BaseModel # @!attribute usage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for # # @return [Float] required :usage_discount, Float diff --git a/lib/orb/request_options.rb b/lib/orb/request_options.rb index 98c7a72b..c30ac87b 100644 --- a/lib/orb/request_options.rb +++ b/lib/orb/request_options.rb @@ -2,10 +2,10 @@ module Orb # Specify HTTP behaviour to use for a specific request. These options supplement - # or override those provided at the client level. + # or override those provided at the client level. # - # When making a request, you can pass an actual {RequestOptions} instance, or - # simply pass a Hash with symbol keys matching the attributes on this class. + # When making a request, you can pass an actual {RequestOptions} instance, or + # simply pass a Hash with symbol keys matching the attributes on this class. class RequestOptions < Orb::Internal::Type::BaseModel # @api private # @@ -27,28 +27,28 @@ def self.validate!(opts) # @!attribute idempotency_key # Idempotency key to send with request and all associated retries. Will only be - # sent for write requests. + # sent for write requests. # # @return [String, nil] optional :idempotency_key, String # @!attribute extra_query # Extra query params to send with the request. These are `.merge`’d into any - # `query` given at the client level. + # `query` given at the client level. # # @return [Hash{String=>Array, String, nil}, nil] optional :extra_query, Orb::Internal::Type::HashOf[Orb::Internal::Type::ArrayOf[String]] # @!attribute extra_headers # Extra headers to send with the request. These are `.merged`’d into any - # `extra_headers` given at the client level. + # `extra_headers` given at the client level. # # @return [Hash{String=>String, nil}, nil] optional :extra_headers, Orb::Internal::Type::HashOf[String, nil?: true] # @!attribute extra_body # Extra data to send with the request. These are deep merged into any data - # generated as part of the normal request. + # generated as part of the normal request. # # @return [Object, nil] optional :extra_body, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown] diff --git a/lib/orb/resources/alerts.rb b/lib/orb/resources/alerts.rb index 357409a6..14e8313a 100644 --- a/lib/orb/resources/alerts.rb +++ b/lib/orb/resources/alerts.rb @@ -46,15 +46,15 @@ def update(alert_configuration_id, params) # This endpoint returns a list of alerts within Orb. # - # The request must specify one of `customer_id`, `external_customer_id`, or - # `subscription_id`. + # The request must specify one of `customer_id`, `external_customer_id`, or + # `subscription_id`. # - # If querying by subscripion_id, the endpoint will return the subscription level - # alerts as well as the plan level alerts associated with the subscription. + # If querying by subscripion_id, the endpoint will return the subscription level + # alerts as well as the plan level alerts associated with the subscription. # - # The list of alerts is ordered starting from the most recently created alert. - # This endpoint follows Orb's - # [standardized pagination format](/api-reference/pagination). + # The list of alerts is ordered starting from the most recently created alert. + # This endpoint follows Orb's + # [standardized pagination format](/api-reference/pagination). # # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {}) # @@ -90,13 +90,13 @@ def list(params = {}) end # This endpoint creates a new alert to monitor a customer's credit balance. There - # are three types of alerts that can be scoped to customers: - # `credit_balance_depleted`, `credit_balance_dropped`, and - # `credit_balance_recovered`. Customers can have a maximum of one of each type of - # alert per [credit balance currency](/product-catalog/prepurchase). - # `credit_balance_dropped` alerts require a list of thresholds to be provided - # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not - # require thresholds. + # are three types of alerts that can be scoped to customers: + # `credit_balance_depleted`, `credit_balance_dropped`, and + # `credit_balance_recovered`. Customers can have a maximum of one of each type of + # alert per [credit balance currency](/product-catalog/prepurchase). + # `credit_balance_dropped` alerts require a list of thresholds to be provided + # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not + # require thresholds. # # @overload create_for_customer(customer_id, currency:, type:, thresholds: nil, request_options: {}) # @@ -121,13 +121,13 @@ def create_for_customer(customer_id, params) end # This endpoint creates a new alert to monitor a customer's credit balance. There - # are three types of alerts that can be scoped to customers: - # `credit_balance_depleted`, `credit_balance_dropped`, and - # `credit_balance_recovered`. Customers can have a maximum of one of each type of - # alert per [credit balance currency](/product-catalog/prepurchase). - # `credit_balance_dropped` alerts require a list of thresholds to be provided - # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not - # require thresholds. + # are three types of alerts that can be scoped to customers: + # `credit_balance_depleted`, `credit_balance_dropped`, and + # `credit_balance_recovered`. Customers can have a maximum of one of each type of + # alert per [credit balance currency](/product-catalog/prepurchase). + # `credit_balance_dropped` alerts require a list of thresholds to be provided + # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not + # require thresholds. # # @overload create_for_external_customer(external_customer_id, currency:, type:, thresholds: nil, request_options: {}) # @@ -153,15 +153,15 @@ def create_for_external_customer(external_customer_id, params) # This endpoint is used to create alerts at the subscription level. # - # Subscription level alerts can be one of two types: `usage_exceeded` or - # `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and - # is triggered when the usage of that metric exceeds predefined thresholds during - # the current billing cycle. A `cost_exceeded` alert is triggered when the total - # amount due during the current billing cycle surpasses predefined thresholds. - # `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each - # subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert - # per metric that is a part of the subscription. Alerts are triggered based on - # usage or cost conditions met during the current billing cycle. + # Subscription level alerts can be one of two types: `usage_exceeded` or + # `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and + # is triggered when the usage of that metric exceeds predefined thresholds during + # the current billing cycle. A `cost_exceeded` alert is triggered when the total + # amount due during the current billing cycle surpasses predefined thresholds. + # `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each + # subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert + # per metric that is a part of the subscription. Alerts are triggered based on + # usage or cost conditions met during the current billing cycle. # # @overload create_for_subscription(subscription_id, thresholds:, type:, metric_id: nil, request_options: {}) # @@ -186,8 +186,8 @@ def create_for_subscription(subscription_id, params) end # This endpoint allows you to disable an alert. To disable a plan-level alert for - # a specific subscription, you must include the `subscription_id`. The - # `subscription_id` is not required for customer or subscription level alerts. + # a specific subscription, you must include the `subscription_id`. The + # `subscription_id` is not required for customer or subscription level alerts. # # @overload disable(alert_configuration_id, subscription_id: nil, request_options: {}) # @@ -210,8 +210,8 @@ def disable(alert_configuration_id, params = {}) end # This endpoint allows you to enable an alert. To enable a plan-level alert for a - # specific subscription, you must include the `subscription_id`. The - # `subscription_id` is not required for customer or subscription level alerts. + # specific subscription, you must include the `subscription_id`. The + # `subscription_id` is not required for customer or subscription level alerts. # # @overload enable(alert_configuration_id, subscription_id: nil, request_options: {}) # diff --git a/lib/orb/resources/coupons.rb b/lib/orb/resources/coupons.rb index 39c9a586..1ea7e2d3 100644 --- a/lib/orb/resources/coupons.rb +++ b/lib/orb/resources/coupons.rb @@ -7,7 +7,7 @@ class Coupons attr_reader :subscriptions # This endpoint allows the creation of coupons, which can then be redeemed at - # subscription creation or plan change. + # subscription creation or plan change. # # @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {}) # @@ -33,10 +33,10 @@ def create(params) # This endpoint returns a list of all coupons for an account in a list format. # - # The list of coupons is ordered starting from the most recently created coupon. - # The response also includes `pagination_metadata`, which lets the caller retrieve - # the next page of results if they exist. More information about pagination can be - # found in the Pagination-metadata schema. + # The list of coupons is ordered starting from the most recently created coupon. + # The response also includes `pagination_metadata`, which lets the caller retrieve + # the next page of results if they exist. More information about pagination can be + # found in the Pagination-metadata schema. # # @overload list(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {}) # @@ -62,8 +62,8 @@ def list(params = {}) end # This endpoint allows a coupon to be archived. Archived coupons can no longer be - # redeemed, and will be hidden from lists of active coupons. Additionally, once a - # coupon is archived, its redemption code can be reused for a different coupon. + # redeemed, and will be hidden from lists of active coupons. Additionally, once a + # coupon is archived, its redemption code can be reused for a different coupon. # # @overload archive(coupon_id, request_options: {}) # @@ -83,8 +83,8 @@ def archive(coupon_id, params = {}) end # This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption - # code, use the [List coupons](list-coupons) endpoint with the redemption_code - # parameter. + # code, use the [List coupons](list-coupons) endpoint with the redemption_code + # parameter. # # @overload fetch(coupon_id, request_options: {}) # diff --git a/lib/orb/resources/coupons/subscriptions.rb b/lib/orb/resources/coupons/subscriptions.rb index 2da61823..0107f4cd 100644 --- a/lib/orb/resources/coupons/subscriptions.rb +++ b/lib/orb/resources/coupons/subscriptions.rb @@ -5,9 +5,9 @@ module Resources class Coupons class Subscriptions # This endpoint returns a list of all subscriptions that have redeemed a given - # coupon as a [paginated](/api-reference/pagination) list, ordered starting from - # the most recently created subscription. For a full discussion of the - # subscription resource, see [Subscription](/core-concepts#subscription). + # coupon as a [paginated](/api-reference/pagination) list, ordered starting from + # the most recently created subscription. For a full discussion of the + # subscription resource, see [Subscription](/core-concepts#subscription). # # @overload list(coupon_id, cursor: nil, limit: nil, request_options: {}) # diff --git a/lib/orb/resources/credit_notes.rb b/lib/orb/resources/credit_notes.rb index 14443679..f11cc7fb 100644 --- a/lib/orb/resources/credit_notes.rb +++ b/lib/orb/resources/credit_notes.rb @@ -4,7 +4,7 @@ module Orb module Resources class CreditNotes # This endpoint is used to create a single - # [`Credit Note`](/invoicing/credit-notes). + # [`Credit Note`](/invoicing/credit-notes). # # @overload create(line_items:, memo: nil, reason: nil, request_options: {}) # @@ -28,8 +28,8 @@ def create(params) end # Get a paginated list of CreditNotes. Users can also filter by customer_id, - # subscription_id, or external_customer_id. The credit notes will be returned in - # reverse chronological order by `creation_time`. + # subscription_id, or external_customer_id. The credit notes will be returned in + # reverse chronological order by `creation_time`. # # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) # @@ -62,7 +62,7 @@ def list(params = {}) end # This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes) - # given an identifier. + # given an identifier. # # @overload fetch(credit_note_id, request_options: {}) # diff --git a/lib/orb/resources/customers.rb b/lib/orb/resources/customers.rb index 8d172b70..0ffc8635 100644 --- a/lib/orb/resources/customers.rb +++ b/lib/orb/resources/customers.rb @@ -13,17 +13,17 @@ class Customers attr_reader :balance_transactions # This operation is used to create an Orb customer, who is party to the core - # billing relationship. See [Customer](/core-concepts##customer) for an overview - # of the customer resource. + # billing relationship. See [Customer](/core-concepts##customer) for an overview + # of the customer resource. # - # This endpoint is critical in the following Orb functionality: + # This endpoint is critical in the following Orb functionality: # - # - Automated charges can be configured by setting `payment_provider` and - # `payment_provider_id` to automatically issue invoices - # - [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured - # by setting `external_customer_id` - # - [Timezone localization](/essentials/timezones) can be configured on a - # per-customer basis by setting the `timezone` parameter + # - Automated charges can be configured by setting `payment_provider` and + # `payment_provider_id` to automatically issue invoices + # - [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured + # by setting `external_customer_id` + # - [Timezone localization](/essentials/timezones) can be configured on a + # per-customer basis by setting the `timezone` parameter # # @overload create(email:, name:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, timezone: nil, request_options: {}) # @@ -62,10 +62,10 @@ def create(params) end # This endpoint can be used to update the `payment_provider`, - # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`, - # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and - # `additional_emails` of an existing customer. Other fields on a customer are - # currently immutable. + # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`, + # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and + # `additional_emails` of an existing customer. Other fields on a customer are + # currently immutable. # # @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) # @@ -104,11 +104,11 @@ def update(customer_id, params = {}) end # This endpoint returns a list of all customers for an account. The list of - # customers is ordered starting from the most recently created customer. This - # endpoint follows Orb's - # [standardized pagination format](/api-reference/pagination). + # customers is ordered starting from the most recently created customer. This + # endpoint follows Orb's + # [standardized pagination format](/api-reference/pagination). # - # See [Customer](/core-concepts##customer) for an overview of the customer model. + # See [Customer](/core-concepts##customer) for an overview of the customer model. # # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) # @@ -141,20 +141,20 @@ def list(params = {}) end # This performs a deletion of this customer, its subscriptions, and its invoices, - # provided the customer does not have any issued invoices. Customers with issued - # invoices cannot be deleted. This operation is irreversible. Note that this is a - # _soft_ deletion, but the data will be inaccessible through the API and Orb - # dashboard. + # provided the customer does not have any issued invoices. Customers with issued + # invoices cannot be deleted. This operation is irreversible. Note that this is a + # _soft_ deletion, but the data will be inaccessible through the API and Orb + # dashboard. # - # For a hard-deletion, please reach out to the Orb team directly. + # For a hard-deletion, please reach out to the Orb team directly. # - # **Note**: This operation happens asynchronously and can be expected to take a - # few minutes to propagate to related resources. However, querying for the - # customer on subsequent GET requests while deletion is in process will reflect - # its deletion with a `deleted: true` property. Once the customer deletion has - # been fully processed, the customer will not be returned in the API. + # **Note**: This operation happens asynchronously and can be expected to take a + # few minutes to propagate to related resources. However, querying for the + # customer on subsequent GET requests while deletion is in process will reflect + # its deletion with a `deleted: true` property. Once the customer deletion has + # been fully processed, the customer will not be returned in the API. # - # On successful processing, this returns an empty dictionary (`{}`) in the API. + # On successful processing, this returns an empty dictionary (`{}`) in the API. # # @overload delete(customer_id, request_options: {}) # @@ -174,11 +174,11 @@ def delete(customer_id, params = {}) end # This endpoint is used to fetch customer details given an identifier. If the - # `Customer` is in the process of being deleted, only the properties `id` and - # `deleted: true` will be returned. + # `Customer` is in the process of being deleted, only the properties `id` and + # `deleted: true` will be returned. # - # See the [Customer resource](/core-concepts#customer) for a full discussion of - # the Customer model. + # See the [Customer resource](/core-concepts#customer) for a full discussion of + # the Customer model. # # @overload fetch(customer_id, request_options: {}) # @@ -198,10 +198,10 @@ def fetch(customer_id, params = {}) end # This endpoint is used to fetch customer details given an `external_customer_id` - # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). + # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). # - # Note that the resource and semantics of this endpoint exactly mirror - # [Get Customer](fetch-customer). + # Note that the resource and semantics of this endpoint exactly mirror + # [Get Customer](fetch-customer). # # @overload fetch_by_external_id(external_customer_id, request_options: {}) # @@ -222,10 +222,10 @@ def fetch_by_external_id(external_customer_id, params = {}) # Sync Orb's payment methods for the customer with their gateway. # - # This method can be called before taking an action that may cause the customer to - # be charged, ensuring that the most up-to-date payment method is charged. + # This method can be called before taking an action that may cause the customer to + # be charged, ensuring that the most up-to-date payment method is charged. # - # **Note**: This functionality is currently only available for Stripe. + # **Note**: This functionality is currently only available for Stripe. # # @overload sync_payment_methods_from_gateway(external_customer_id, request_options: {}) # @@ -249,10 +249,10 @@ def sync_payment_methods_from_gateway(external_customer_id, params = {}) # Sync Orb's payment methods for the customer with their gateway. # - # This method can be called before taking an action that may cause the customer to - # be charged, ensuring that the most up-to-date payment method is charged. + # This method can be called before taking an action that may cause the customer to + # be charged, ensuring that the most up-to-date payment method is charged. # - # **Note**: This functionality is currently only available for Stripe. + # **Note**: This functionality is currently only available for Stripe. # # @overload sync_payment_methods_from_gateway_by_external_customer_id(customer_id, request_options: {}) # @@ -272,9 +272,9 @@ def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, param end # This endpoint is used to update customer details given an `external_customer_id` - # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the - # resource and semantics of this endpoint exactly mirror - # [Update Customer](update-customer). + # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the + # resource and semantics of this endpoint exactly mirror + # [Update Customer](update-customer). # # @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) # diff --git a/lib/orb/resources/customers/balance_transactions.rb b/lib/orb/resources/customers/balance_transactions.rb index a97da4df..9a189f77 100644 --- a/lib/orb/resources/customers/balance_transactions.rb +++ b/lib/orb/resources/customers/balance_transactions.rb @@ -5,7 +5,7 @@ module Resources class Customers class BalanceTransactions # Creates an immutable balance transaction that updates the customer's balance and - # returns back the newly created transaction. + # returns back the newly created transaction. # # @overload create(customer_id, amount:, type:, description: nil, request_options: {}) # @@ -31,32 +31,32 @@ def create(customer_id, params) # ## The customer balance # - # The customer balance is an amount in the customer's currency, which Orb - # automatically applies to subsequent invoices. This balance can be adjusted - # manually via Orb's webapp on the customer details page. You can use this balance - # to provide a fixed mid-period credit to the customer. Commonly, this is done due - # to system downtime/SLA violation, or an adhoc adjustment discussed with the - # customer. + # The customer balance is an amount in the customer's currency, which Orb + # automatically applies to subsequent invoices. This balance can be adjusted + # manually via Orb's webapp on the customer details page. You can use this balance + # to provide a fixed mid-period credit to the customer. Commonly, this is done due + # to system downtime/SLA violation, or an adhoc adjustment discussed with the + # customer. # - # If the balance is a positive value at the time of invoicing, it represents that - # the customer has credit that should be used to offset the amount due on the next - # issued invoice. In this case, Orb will automatically reduce the next invoice by - # the balance amount, and roll over any remaining balance if the invoice is fully - # discounted. + # If the balance is a positive value at the time of invoicing, it represents that + # the customer has credit that should be used to offset the amount due on the next + # issued invoice. In this case, Orb will automatically reduce the next invoice by + # the balance amount, and roll over any remaining balance if the invoice is fully + # discounted. # - # If the balance is a negative value at the time of invoicing, Orb will increase - # the invoice's amount due with a positive adjustment, and reset the balance to 0. + # If the balance is a negative value at the time of invoicing, Orb will increase + # the invoice's amount due with a positive adjustment, and reset the balance to 0. # - # This endpoint retrieves all customer balance transactions in reverse - # chronological order for a single customer, providing a complete audit trail of - # all adjustments and invoice applications. + # This endpoint retrieves all customer balance transactions in reverse + # chronological order for a single customer, providing a complete audit trail of + # all adjustments and invoice applications. # - # ## Eligibility + # ## Eligibility # - # The customer balance can only be applied to invoices or adjusted manually if - # invoices are not synced to a separate invoicing provider. If a payment gateway - # such as Stripe is used, the balance will be applied to the invoice before - # forwarding payment to the gateway. + # The customer balance can only be applied to invoices or adjusted manually if + # invoices are not synced to a separate invoicing provider. If a payment gateway + # such as Stripe is used, the balance will be applied to the invoice before + # forwarding payment to the gateway. # # @overload list(customer_id, cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {}) # diff --git a/lib/orb/resources/customers/costs.rb b/lib/orb/resources/customers/costs.rb index cf4ec619..4378122e 100644 --- a/lib/orb/resources/customers/costs.rb +++ b/lib/orb/resources/customers/costs.rb @@ -5,122 +5,122 @@ module Resources class Customers class Costs # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in - # Orb, calculated by applying pricing information to the underlying usage (see the - # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) - # to fetch usage per metric, in usage units rather than a currency). - # - # This endpoint can be leveraged for internal tooling and to provide a more - # transparent billing experience for your end users: - # - # 1. Understand the cost breakdown per line item historically and in real-time for - # the current billing period. - # 2. Provide customer visibility into how different services are contributing to - # the overall invoice with a per-day timeseries (as compared to the - # [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource, - # which represents a snapshot for the current period). - # 3. Assess how minimums and discounts affect your customers by teasing apart - # costs directly as a result of usage, as opposed to minimums and discounts at - # the plan and price level. - # 4. Gain insight into key customer health metrics, such as the percent - # utilization of the minimum committed spend. - # - # ## Fetching subscriptions - # - # By default, this endpoint fetches the currently active subscription for the - # customer, and returns cost information for the subscription's current billing - # period, broken down by each participating price. If there are no currently - # active subscriptions, this will instead default to the most recently active - # subscription or return an empty series if none are found. For example, if your - # plan charges for compute hours, job runs, and data syncs, then this endpoint - # would provide a daily breakdown of your customer's cost for each of those axes. - # - # If timeframe bounds are specified, Orb fetches all subscriptions that were - # active in that timeframe. If two subscriptions overlap on a single day, costs - # from each price will be summed, and prices for both subscriptions will be - # included in the breakdown. - # - # ## Prepaid plans - # - # For plans that include prices which deduct credits rather than accrue in-arrears - # charges in a billable currency, this endpoint will return the total deduction - # amount, in credits, for the specified timeframe. - # - # ## Cumulative subtotals and totals - # - # Since the subtotal and total must factor in any billing-period level discounts - # and minimums, it's most meaningful to consider costs relative to the start of - # the subscription's billing period. As a result, by default this endpoint returns - # cumulative totals since the beginning of the billing period. In particular, the - # `timeframe_start` of a returned timeframe window is _always_ the beginning of - # the billing period and `timeframe_end` is incremented one day at a time to build - # the result. - # - # A customer that uses a few API calls a day but has a minimum commitment might - # exhibit the following pattern for their subtotal and total in the first few days - # of the month. Here, we assume that each API call is $2.50, the customer's plan - # has a monthly minimum of $50 for this price, and that the subscription's billing - # period bounds are aligned to the first of the month: - # - # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) | - # | --------------- | ------------- | ---------------- | -------- | ------------------------ | - # | 2023-02-01 | 2023-02-02 | 9 | $22.50 | $50.00 | - # | 2023-02-01 | 2023-02-03 | 19 | $47.50 | $50.00 | - # | 2023-02-01 | 2023-02-04 | 20 | $50.00 | $50.00 | - # | 2023-02-01 | 2023-02-05 | 28 | $70.00 | $70.00 | - # | 2023-02-01 | 2023-02-06 | 36 | $90.00 | $90.00 | - # - # ### Periodic values - # - # When the query parameter `view_mode=periodic` is specified, Orb will return an - # incremental day-by-day view of costs. In this case, there will always be a - # one-day difference between `timeframe_start` and `timeframe_end` for the - # timeframes returned. This is a transform on top of the cumulative costs, - # calculated by taking the difference of each timeframe with the last. Note that - # in the above example, the `Total` value would be 0 for the second two data - # points, since the minimum commitment has not yet been hit and each day is not - # contributing anything to the total cost. - # - # ## Timeframe bounds - # - # For an active subscription, both timeframes should be specified in the request. - # If a subscription starts or ends within the timeframe, the response will only - # include windows where the subscription is active. If a subscription has ended, - # no timeframe bounds need to be specified and the response will default to the - # billing period when the subscription was last active. - # - # As noted above, `timeframe_start` for a given cumulative datapoint is always the - # beginning of the billing period, and `timeframe_end` is incremented one day at a - # time to construct the response. When a timeframe is passed in that is not - # aligned to the current subscription's billing period, the response will contain - # cumulative totals from multiple billing periods. - # - # Suppose the queried customer has a subscription aligned to the 15th of every - # month. If this endpoint is queried with the date range `2023-06-01` - - # `2023-07-01`, the first data point will represent about half a billing period's - # worth of costs, accounting for accruals from the start of the billing period and - # inclusive of the first day of the timeframe - # (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`) - # - # | datapoint index | timeframe_start | timeframe_end | - # | --------------- | --------------- | ------------- | - # | 0 | 2023-05-15 | 2023-06-02 | - # | 1 | 2023-05-15 | 2023-06-03 | - # | 2 | ... | ... | - # | 3 | 2023-05-15 | 2023-06-14 | - # | 4 | 2023-06-15 | 2023-06-16 | - # | 5 | 2023-06-15 | 2023-06-17 | - # | 6 | ... | ... | - # | 7 | 2023-06-15 | 2023-07-01 | - # - # You can see this sliced timeframe visualized - # [here](https://i.imgur.com/TXhYgme.png). - # - # ### Matrix prices - # - # When a price uses matrix pricing, it's important to view costs grouped by those - # matrix dimensions. Orb will return `price_groups` with the `grouping_key` and - # `secondary_grouping_key` based on the matrix price definition, for each - # `grouping_value` and `secondary_grouping_value` available. + # Orb, calculated by applying pricing information to the underlying usage (see the + # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) + # to fetch usage per metric, in usage units rather than a currency). + # + # This endpoint can be leveraged for internal tooling and to provide a more + # transparent billing experience for your end users: + # + # 1. Understand the cost breakdown per line item historically and in real-time for + # the current billing period. + # 2. Provide customer visibility into how different services are contributing to + # the overall invoice with a per-day timeseries (as compared to the + # [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource, + # which represents a snapshot for the current period). + # 3. Assess how minimums and discounts affect your customers by teasing apart + # costs directly as a result of usage, as opposed to minimums and discounts at + # the plan and price level. + # 4. Gain insight into key customer health metrics, such as the percent + # utilization of the minimum committed spend. + # + # ## Fetching subscriptions + # + # By default, this endpoint fetches the currently active subscription for the + # customer, and returns cost information for the subscription's current billing + # period, broken down by each participating price. If there are no currently + # active subscriptions, this will instead default to the most recently active + # subscription or return an empty series if none are found. For example, if your + # plan charges for compute hours, job runs, and data syncs, then this endpoint + # would provide a daily breakdown of your customer's cost for each of those axes. + # + # If timeframe bounds are specified, Orb fetches all subscriptions that were + # active in that timeframe. If two subscriptions overlap on a single day, costs + # from each price will be summed, and prices for both subscriptions will be + # included in the breakdown. + # + # ## Prepaid plans + # + # For plans that include prices which deduct credits rather than accrue in-arrears + # charges in a billable currency, this endpoint will return the total deduction + # amount, in credits, for the specified timeframe. + # + # ## Cumulative subtotals and totals + # + # Since the subtotal and total must factor in any billing-period level discounts + # and minimums, it's most meaningful to consider costs relative to the start of + # the subscription's billing period. As a result, by default this endpoint returns + # cumulative totals since the beginning of the billing period. In particular, the + # `timeframe_start` of a returned timeframe window is _always_ the beginning of + # the billing period and `timeframe_end` is incremented one day at a time to build + # the result. + # + # A customer that uses a few API calls a day but has a minimum commitment might + # exhibit the following pattern for their subtotal and total in the first few days + # of the month. Here, we assume that each API call is $2.50, the customer's plan + # has a monthly minimum of $50 for this price, and that the subscription's billing + # period bounds are aligned to the first of the month: + # + # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) | + # | --------------- | ------------- | ---------------- | -------- | ------------------------ | + # | 2023-02-01 | 2023-02-02 | 9 | $22.50 | $50.00 | + # | 2023-02-01 | 2023-02-03 | 19 | $47.50 | $50.00 | + # | 2023-02-01 | 2023-02-04 | 20 | $50.00 | $50.00 | + # | 2023-02-01 | 2023-02-05 | 28 | $70.00 | $70.00 | + # | 2023-02-01 | 2023-02-06 | 36 | $90.00 | $90.00 | + # + # ### Periodic values + # + # When the query parameter `view_mode=periodic` is specified, Orb will return an + # incremental day-by-day view of costs. In this case, there will always be a + # one-day difference between `timeframe_start` and `timeframe_end` for the + # timeframes returned. This is a transform on top of the cumulative costs, + # calculated by taking the difference of each timeframe with the last. Note that + # in the above example, the `Total` value would be 0 for the second two data + # points, since the minimum commitment has not yet been hit and each day is not + # contributing anything to the total cost. + # + # ## Timeframe bounds + # + # For an active subscription, both timeframes should be specified in the request. + # If a subscription starts or ends within the timeframe, the response will only + # include windows where the subscription is active. If a subscription has ended, + # no timeframe bounds need to be specified and the response will default to the + # billing period when the subscription was last active. + # + # As noted above, `timeframe_start` for a given cumulative datapoint is always the + # beginning of the billing period, and `timeframe_end` is incremented one day at a + # time to construct the response. When a timeframe is passed in that is not + # aligned to the current subscription's billing period, the response will contain + # cumulative totals from multiple billing periods. + # + # Suppose the queried customer has a subscription aligned to the 15th of every + # month. If this endpoint is queried with the date range `2023-06-01` - + # `2023-07-01`, the first data point will represent about half a billing period's + # worth of costs, accounting for accruals from the start of the billing period and + # inclusive of the first day of the timeframe + # (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`) + # + # | datapoint index | timeframe_start | timeframe_end | + # | --------------- | --------------- | ------------- | + # | 0 | 2023-05-15 | 2023-06-02 | + # | 1 | 2023-05-15 | 2023-06-03 | + # | 2 | ... | ... | + # | 3 | 2023-05-15 | 2023-06-14 | + # | 4 | 2023-06-15 | 2023-06-16 | + # | 5 | 2023-06-15 | 2023-06-17 | + # | 6 | ... | ... | + # | 7 | 2023-06-15 | 2023-07-01 | + # + # You can see this sliced timeframe visualized + # [here](https://i.imgur.com/TXhYgme.png). + # + # ### Matrix prices + # + # When a price uses matrix pricing, it's important to view costs grouped by those + # matrix dimensions. Orb will return `price_groups` with the `grouping_key` and + # `secondary_grouping_key` based on the matrix price definition, for each + # `grouping_value` and `secondary_grouping_value` available. # # @overload list(customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # @@ -146,122 +146,122 @@ def list(customer_id, params = {}) end # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in - # Orb, calculated by applying pricing information to the underlying usage (see the - # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) - # to fetch usage per metric, in usage units rather than a currency). - # - # This endpoint can be leveraged for internal tooling and to provide a more - # transparent billing experience for your end users: - # - # 1. Understand the cost breakdown per line item historically and in real-time for - # the current billing period. - # 2. Provide customer visibility into how different services are contributing to - # the overall invoice with a per-day timeseries (as compared to the - # [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource, - # which represents a snapshot for the current period). - # 3. Assess how minimums and discounts affect your customers by teasing apart - # costs directly as a result of usage, as opposed to minimums and discounts at - # the plan and price level. - # 4. Gain insight into key customer health metrics, such as the percent - # utilization of the minimum committed spend. - # - # ## Fetching subscriptions - # - # By default, this endpoint fetches the currently active subscription for the - # customer, and returns cost information for the subscription's current billing - # period, broken down by each participating price. If there are no currently - # active subscriptions, this will instead default to the most recently active - # subscription or return an empty series if none are found. For example, if your - # plan charges for compute hours, job runs, and data syncs, then this endpoint - # would provide a daily breakdown of your customer's cost for each of those axes. - # - # If timeframe bounds are specified, Orb fetches all subscriptions that were - # active in that timeframe. If two subscriptions overlap on a single day, costs - # from each price will be summed, and prices for both subscriptions will be - # included in the breakdown. - # - # ## Prepaid plans - # - # For plans that include prices which deduct credits rather than accrue in-arrears - # charges in a billable currency, this endpoint will return the total deduction - # amount, in credits, for the specified timeframe. - # - # ## Cumulative subtotals and totals - # - # Since the subtotal and total must factor in any billing-period level discounts - # and minimums, it's most meaningful to consider costs relative to the start of - # the subscription's billing period. As a result, by default this endpoint returns - # cumulative totals since the beginning of the billing period. In particular, the - # `timeframe_start` of a returned timeframe window is _always_ the beginning of - # the billing period and `timeframe_end` is incremented one day at a time to build - # the result. - # - # A customer that uses a few API calls a day but has a minimum commitment might - # exhibit the following pattern for their subtotal and total in the first few days - # of the month. Here, we assume that each API call is $2.50, the customer's plan - # has a monthly minimum of $50 for this price, and that the subscription's billing - # period bounds are aligned to the first of the month: - # - # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) | - # | --------------- | ------------- | ---------------- | -------- | ------------------------ | - # | 2023-02-01 | 2023-02-02 | 9 | $22.50 | $50.00 | - # | 2023-02-01 | 2023-02-03 | 19 | $47.50 | $50.00 | - # | 2023-02-01 | 2023-02-04 | 20 | $50.00 | $50.00 | - # | 2023-02-01 | 2023-02-05 | 28 | $70.00 | $70.00 | - # | 2023-02-01 | 2023-02-06 | 36 | $90.00 | $90.00 | - # - # ### Periodic values - # - # When the query parameter `view_mode=periodic` is specified, Orb will return an - # incremental day-by-day view of costs. In this case, there will always be a - # one-day difference between `timeframe_start` and `timeframe_end` for the - # timeframes returned. This is a transform on top of the cumulative costs, - # calculated by taking the difference of each timeframe with the last. Note that - # in the above example, the `Total` value would be 0 for the second two data - # points, since the minimum commitment has not yet been hit and each day is not - # contributing anything to the total cost. - # - # ## Timeframe bounds - # - # For an active subscription, both timeframes should be specified in the request. - # If a subscription starts or ends within the timeframe, the response will only - # include windows where the subscription is active. If a subscription has ended, - # no timeframe bounds need to be specified and the response will default to the - # billing period when the subscription was last active. - # - # As noted above, `timeframe_start` for a given cumulative datapoint is always the - # beginning of the billing period, and `timeframe_end` is incremented one day at a - # time to construct the response. When a timeframe is passed in that is not - # aligned to the current subscription's billing period, the response will contain - # cumulative totals from multiple billing periods. - # - # Suppose the queried customer has a subscription aligned to the 15th of every - # month. If this endpoint is queried with the date range `2023-06-01` - - # `2023-07-01`, the first data point will represent about half a billing period's - # worth of costs, accounting for accruals from the start of the billing period and - # inclusive of the first day of the timeframe - # (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`) - # - # | datapoint index | timeframe_start | timeframe_end | - # | --------------- | --------------- | ------------- | - # | 0 | 2023-05-15 | 2023-06-02 | - # | 1 | 2023-05-15 | 2023-06-03 | - # | 2 | ... | ... | - # | 3 | 2023-05-15 | 2023-06-14 | - # | 4 | 2023-06-15 | 2023-06-16 | - # | 5 | 2023-06-15 | 2023-06-17 | - # | 6 | ... | ... | - # | 7 | 2023-06-15 | 2023-07-01 | - # - # You can see this sliced timeframe visualized - # [here](https://i.imgur.com/TXhYgme.png). - # - # ### Matrix prices - # - # When a price uses matrix pricing, it's important to view costs grouped by those - # matrix dimensions. Orb will return `price_groups` with the `grouping_key` and - # `secondary_grouping_key` based on the matrix price definition, for each - # `grouping_value` and `secondary_grouping_value` available. + # Orb, calculated by applying pricing information to the underlying usage (see the + # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) + # to fetch usage per metric, in usage units rather than a currency). + # + # This endpoint can be leveraged for internal tooling and to provide a more + # transparent billing experience for your end users: + # + # 1. Understand the cost breakdown per line item historically and in real-time for + # the current billing period. + # 2. Provide customer visibility into how different services are contributing to + # the overall invoice with a per-day timeseries (as compared to the + # [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource, + # which represents a snapshot for the current period). + # 3. Assess how minimums and discounts affect your customers by teasing apart + # costs directly as a result of usage, as opposed to minimums and discounts at + # the plan and price level. + # 4. Gain insight into key customer health metrics, such as the percent + # utilization of the minimum committed spend. + # + # ## Fetching subscriptions + # + # By default, this endpoint fetches the currently active subscription for the + # customer, and returns cost information for the subscription's current billing + # period, broken down by each participating price. If there are no currently + # active subscriptions, this will instead default to the most recently active + # subscription or return an empty series if none are found. For example, if your + # plan charges for compute hours, job runs, and data syncs, then this endpoint + # would provide a daily breakdown of your customer's cost for each of those axes. + # + # If timeframe bounds are specified, Orb fetches all subscriptions that were + # active in that timeframe. If two subscriptions overlap on a single day, costs + # from each price will be summed, and prices for both subscriptions will be + # included in the breakdown. + # + # ## Prepaid plans + # + # For plans that include prices which deduct credits rather than accrue in-arrears + # charges in a billable currency, this endpoint will return the total deduction + # amount, in credits, for the specified timeframe. + # + # ## Cumulative subtotals and totals + # + # Since the subtotal and total must factor in any billing-period level discounts + # and minimums, it's most meaningful to consider costs relative to the start of + # the subscription's billing period. As a result, by default this endpoint returns + # cumulative totals since the beginning of the billing period. In particular, the + # `timeframe_start` of a returned timeframe window is _always_ the beginning of + # the billing period and `timeframe_end` is incremented one day at a time to build + # the result. + # + # A customer that uses a few API calls a day but has a minimum commitment might + # exhibit the following pattern for their subtotal and total in the first few days + # of the month. Here, we assume that each API call is $2.50, the customer's plan + # has a monthly minimum of $50 for this price, and that the subscription's billing + # period bounds are aligned to the first of the month: + # + # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) | + # | --------------- | ------------- | ---------------- | -------- | ------------------------ | + # | 2023-02-01 | 2023-02-02 | 9 | $22.50 | $50.00 | + # | 2023-02-01 | 2023-02-03 | 19 | $47.50 | $50.00 | + # | 2023-02-01 | 2023-02-04 | 20 | $50.00 | $50.00 | + # | 2023-02-01 | 2023-02-05 | 28 | $70.00 | $70.00 | + # | 2023-02-01 | 2023-02-06 | 36 | $90.00 | $90.00 | + # + # ### Periodic values + # + # When the query parameter `view_mode=periodic` is specified, Orb will return an + # incremental day-by-day view of costs. In this case, there will always be a + # one-day difference between `timeframe_start` and `timeframe_end` for the + # timeframes returned. This is a transform on top of the cumulative costs, + # calculated by taking the difference of each timeframe with the last. Note that + # in the above example, the `Total` value would be 0 for the second two data + # points, since the minimum commitment has not yet been hit and each day is not + # contributing anything to the total cost. + # + # ## Timeframe bounds + # + # For an active subscription, both timeframes should be specified in the request. + # If a subscription starts or ends within the timeframe, the response will only + # include windows where the subscription is active. If a subscription has ended, + # no timeframe bounds need to be specified and the response will default to the + # billing period when the subscription was last active. + # + # As noted above, `timeframe_start` for a given cumulative datapoint is always the + # beginning of the billing period, and `timeframe_end` is incremented one day at a + # time to construct the response. When a timeframe is passed in that is not + # aligned to the current subscription's billing period, the response will contain + # cumulative totals from multiple billing periods. + # + # Suppose the queried customer has a subscription aligned to the 15th of every + # month. If this endpoint is queried with the date range `2023-06-01` - + # `2023-07-01`, the first data point will represent about half a billing period's + # worth of costs, accounting for accruals from the start of the billing period and + # inclusive of the first day of the timeframe + # (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`) + # + # | datapoint index | timeframe_start | timeframe_end | + # | --------------- | --------------- | ------------- | + # | 0 | 2023-05-15 | 2023-06-02 | + # | 1 | 2023-05-15 | 2023-06-03 | + # | 2 | ... | ... | + # | 3 | 2023-05-15 | 2023-06-14 | + # | 4 | 2023-06-15 | 2023-06-16 | + # | 5 | 2023-06-15 | 2023-06-17 | + # | 6 | ... | ... | + # | 7 | 2023-06-15 | 2023-07-01 | + # + # You can see this sliced timeframe visualized + # [here](https://i.imgur.com/TXhYgme.png). + # + # ### Matrix prices + # + # When a price uses matrix pricing, it's important to view costs grouped by those + # matrix dimensions. Orb will return `price_groups` with the `grouping_key` and + # `secondary_grouping_key` based on the matrix price definition, for each + # `grouping_value` and `secondary_grouping_value` available. # # @overload list_by_external_id(external_customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # diff --git a/lib/orb/resources/customers/credits.rb b/lib/orb/resources/customers/credits.rb index d5eb5b68..aadf6ad3 100644 --- a/lib/orb/resources/customers/credits.rb +++ b/lib/orb/resources/customers/credits.rb @@ -12,11 +12,11 @@ class Credits # Returns a paginated list of unexpired, non-zero credit blocks for a customer. # - # If `include_all_blocks` is set to `true`, all credit blocks (including expired - # and depleted blocks) will be included in the response. + # If `include_all_blocks` is set to `true`, all credit blocks (including expired + # and depleted blocks) will be included in the response. # - # Note that `currency` defaults to credits if not specified. To use a real world - # currency, set `currency` to an ISO 4217 string. + # Note that `currency` defaults to credits if not specified. To use a real world + # currency, set `currency` to an ISO 4217 string. # # @overload list(customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) # @@ -44,11 +44,11 @@ def list(customer_id, params = {}) # Returns a paginated list of unexpired, non-zero credit blocks for a customer. # - # If `include_all_blocks` is set to `true`, all credit blocks (including expired - # and depleted blocks) will be included in the response. + # If `include_all_blocks` is set to `true`, all credit blocks (including expired + # and depleted blocks) will be included in the response. # - # Note that `currency` defaults to credits if not specified. To use a real world - # currency, set `currency` to an ISO 4217 string. + # Note that `currency` defaults to credits if not specified. To use a real world + # currency, set `currency` to an ISO 4217 string. # # @overload list_by_external_id(external_customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) # diff --git a/lib/orb/resources/customers/credits/ledger.rb b/lib/orb/resources/customers/credits/ledger.rb index 40bb7446..f379f7ac 100644 --- a/lib/orb/resources/customers/credits/ledger.rb +++ b/lib/orb/resources/customers/credits/ledger.rb @@ -6,86 +6,86 @@ class Customers class Credits class Ledger # The credits ledger provides _auditing_ functionality over Orb's credits system - # with a list of actions that have taken place to modify a customer's credit - # balance. This [paginated endpoint](/api-reference/pagination) lists these - # entries, starting from the most recent ledger entry. + # with a list of actions that have taken place to modify a customer's credit + # balance. This [paginated endpoint](/api-reference/pagination) lists these + # entries, starting from the most recent ledger entry. # - # More details on using Orb's real-time credit feature are - # [here](/product-catalog/prepurchase). + # More details on using Orb's real-time credit feature are + # [here](/product-catalog/prepurchase). # - # There are four major types of modifications to credit balance, detailed below. + # There are four major types of modifications to credit balance, detailed below. # - # ## Increment + # ## Increment # - # Credits (which optionally expire on a future date) can be added via the API - # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action - # will always contain the total eligible starting and ending balance for the - # customer at the time the entry was added to the ledger. + # Credits (which optionally expire on a future date) can be added via the API + # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action + # will always contain the total eligible starting and ending balance for the + # customer at the time the entry was added to the ledger. # - # ## Decrement + # ## Decrement # - # Deductions can occur as a result of an API call to create a ledger entry (see - # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of - # incurring usage. Both ledger entries present the `decrement` entry type. + # Deductions can occur as a result of an API call to create a ledger entry (see + # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of + # incurring usage. Both ledger entries present the `decrement` entry type. # - # As usage for a customer is reported into Orb, credits may be deducted according - # to the customer's plan configuration. An automated deduction of this type will - # result in a ledger entry, also with a starting and ending balance. In order to - # provide better tracing capabilities for automatic deductions, Orb always - # associates each automatic deduction with the `event_id` at the time of - # ingestion, used to pinpoint _why_ credit deduction took place and to ensure that - # credits are never deducted without an associated usage event. + # As usage for a customer is reported into Orb, credits may be deducted according + # to the customer's plan configuration. An automated deduction of this type will + # result in a ledger entry, also with a starting and ending balance. In order to + # provide better tracing capabilities for automatic deductions, Orb always + # associates each automatic deduction with the `event_id` at the time of + # ingestion, used to pinpoint _why_ credit deduction took place and to ensure that + # credits are never deducted without an associated usage event. # - # By default, Orb uses an algorithm that automatically deducts from the _soonest - # expiring credit block_ first in order to ensure that all credits are utilized - # appropriately. As an example, if trial credits with an expiration date of 2 - # weeks from now are present for a customer, they will be used before any - # deductions take place from a non-expiring credit block. + # By default, Orb uses an algorithm that automatically deducts from the _soonest + # expiring credit block_ first in order to ensure that all credits are utilized + # appropriately. As an example, if trial credits with an expiration date of 2 + # weeks from now are present for a customer, they will be used before any + # deductions take place from a non-expiring credit block. # - # If there are multiple blocks with the same expiration date, Orb will deduct from - # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost - # basis before paid credits with a $5.00 cost basis). + # If there are multiple blocks with the same expiration date, Orb will deduct from + # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost + # basis before paid credits with a $5.00 cost basis). # - # It's also possible for a single usage event's deduction to _span_ credit blocks. - # In this case, Orb will deduct from the next block, ending at the credit block - # which consists of unexpiring credits. Each of these deductions will lead to a - # _separate_ ledger entry, one per credit block that is deducted from. By default, - # the customer's total credit balance in Orb can be negative as a result of a - # decrement. + # It's also possible for a single usage event's deduction to _span_ credit blocks. + # In this case, Orb will deduct from the next block, ending at the credit block + # which consists of unexpiring credits. Each of these deductions will lead to a + # _separate_ ledger entry, one per credit block that is deducted from. By default, + # the customer's total credit balance in Orb can be negative as a result of a + # decrement. # - # ## Expiration change + # ## Expiration change # - # The expiry of credits can be changed as a result of the API (See - # [Add Ledger Entry](create-ledger-entry)). This will create a ledger entry that - # specifies the balance as well as the initial and target expiry dates. + # The expiry of credits can be changed as a result of the API (See + # [Add Ledger Entry](create-ledger-entry)). This will create a ledger entry that + # specifies the balance as well as the initial and target expiry dates. # - # Note that for this entry type, `starting_balance` will equal `ending_balance`, - # and the `amount` represents the balance transferred. The credit block linked to - # the ledger entry is the source credit block from which there was an expiration - # change + # Note that for this entry type, `starting_balance` will equal `ending_balance`, + # and the `amount` represents the balance transferred. The credit block linked to + # the ledger entry is the source credit block from which there was an expiration + # change # - # ## Credits expiry + # ## Credits expiry # - # When a set of credits expire on pre-set expiration date, the customer's balance - # automatically reflects this change and adds an entry to the ledger indicating - # this event. Note that credit expiry should always happen close to a date - # boundary in the customer's timezone. + # When a set of credits expire on pre-set expiration date, the customer's balance + # automatically reflects this change and adds an entry to the ledger indicating + # this event. Note that credit expiry should always happen close to a date + # boundary in the customer's timezone. # - # ## Void initiated + # ## Void initiated # - # Credit blocks can be voided via the API. The `amount` on this entry corresponds - # to the number of credits that were remaining in the block at time of void. - # `void_reason` will be populated if the void is created with a reason. + # Credit blocks can be voided via the API. The `amount` on this entry corresponds + # to the number of credits that were remaining in the block at time of void. + # `void_reason` will be populated if the void is created with a reason. # - # ## Void + # ## Void # - # When a set of credits is voided, the customer's balance automatically reflects - # this change and adds an entry to the ledger indicating this event. + # When a set of credits is voided, the customer's balance automatically reflects + # this change and adds an entry to the ledger indicating this event. # - # ## Amendment + # ## Amendment # - # When credits are added to a customer's balance as a result of a correction, this - # entry will be added to the ledger to indicate the adjustment of credits. + # When credits are added to a customer's balance as a result of a correction, this + # entry will be added to the ledger to indicate the adjustment of credits. # # @overload list(customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {}) # @@ -123,115 +123,115 @@ def list(customer_id, params = {}) end # This endpoint allows you to create a new ledger entry for a specified customer's - # balance. This can be used to increment balance, deduct credits, and change the - # expiry date of existing credits. - # - # ## Effects of adding a ledger entry - # - # 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) - # will return a credit block that represents the changes (i.e. balance changes - # or transfers). - # 2. A ledger entry will be added to the credits ledger for this customer, and - # therefore returned in the - # [View Credits Ledger](fetch-customer-credits-ledger) response as well as - # serialized in the response to this request. In the case of deductions without - # a specified block, multiple ledger entries may be created if the deduction - # spans credit blocks. - # 3. If `invoice_settings` is specified, an invoice will be created that reflects - # the cost of the credits (based on `amount` and `per_unit_cost_basis`). - # - # ## Adding credits - # - # Adding credits is done by creating an entry of type `increment`. This requires - # the caller to specify a number of credits as well as an optional expiry date in - # `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with - # auditing. When adding credits, the caller can also specify a cost basis - # per-credit, to indicate how much in USD a customer paid for a single credit in a - # block. This can later be used for revenue recognition. - # - # The following snippet illustrates a sample request body to increment credits - # which will expire in January of 2022. - # - # ```json - # { - # "entry_type": "increment", - # "amount": 100, - # "expiry_date": "2022-12-28", - # "per_unit_cost_basis": "0.20", - # "description": "Purchased 100 credits" - # } - # ``` - # - # Note that by default, Orb will always first increment any _negative_ balance in - # existing blocks before adding the remaining amount to the desired credit block. - # - # ### Invoicing for credits - # - # By default, Orb manipulates the credit ledger but does not charge for credits. - # However, if you pass `invoice_settings` in the body of this request, Orb will - # also generate a one-off invoice for the customer for the credits pre-purchase. - # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges - # on the invoice are calculated by multiplying the cost basis with the number of - # credit units added. - # - # ## Deducting Credits - # - # Orb allows you to deduct credits from a customer by creating an entry of type - # `decrement`. Orb matches the algorithm for automatic deductions for determining - # which credit blocks to decrement from. In the case that the deduction leads to - # multiple ledger entries, the response from this endpoint will be the final - # deduction. Orb also optionally allows specifying a description to assist with - # auditing. - # - # The following snippet illustrates a sample request body to decrement credits. - # - # ```json - # { - # "entry_type": "decrement", - # "amount": 20, - # "description": "Removing excess credits" - # } - # ``` - # - # ## Changing credits expiry - # - # If you'd like to change when existing credits expire, you should create a ledger - # entry of type `expiration_change`. For this entry, the required parameter - # `expiry_date` identifies the _originating_ block, and the required parameter - # `target_expiry_date` identifies when the transferred credits should now expire. - # A new credit block will be created with expiry date `target_expiry_date`, with - # the same cost basis data as the original credit block, if present. - # - # Note that the balance of the block with the given `expiry_date` must be at least - # equal to the desired transfer amount determined by the `amount` parameter. - # - # The following snippet illustrates a sample request body to extend the expiration - # date of credits by one year: - # - # ```json - # { - # "entry_type": "expiration_change", - # "amount": 10, - # "expiry_date": "2022-12-28", - # "block_id": "UiUhFWeLHPrBY4Ad", - # "target_expiry_date": "2023-12-28", - # "description": "Extending credit validity" - # } - # ``` - # - # ## Voiding credits - # - # If you'd like to void a credit block, create a ledger entry of type `void`. For - # this entry, `block_id` is required to identify the block, and `amount` indicates - # how many credits to void, up to the block's initial balance. Pass in a - # `void_reason` of `refund` if the void is due to a refund. - # - # ## Amendment - # - # If you'd like to undo a decrement on a credit block, create a ledger entry of - # type `amendment`. For this entry, `block_id` is required to identify the block - # that was originally decremented from, and `amount` indicates how many credits to - # return to the customer, up to the block's initial balance. + # balance. This can be used to increment balance, deduct credits, and change the + # expiry date of existing credits. + # + # ## Effects of adding a ledger entry + # + # 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) + # will return a credit block that represents the changes (i.e. balance changes + # or transfers). + # 2. A ledger entry will be added to the credits ledger for this customer, and + # therefore returned in the + # [View Credits Ledger](fetch-customer-credits-ledger) response as well as + # serialized in the response to this request. In the case of deductions without + # a specified block, multiple ledger entries may be created if the deduction + # spans credit blocks. + # 3. If `invoice_settings` is specified, an invoice will be created that reflects + # the cost of the credits (based on `amount` and `per_unit_cost_basis`). + # + # ## Adding credits + # + # Adding credits is done by creating an entry of type `increment`. This requires + # the caller to specify a number of credits as well as an optional expiry date in + # `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with + # auditing. When adding credits, the caller can also specify a cost basis + # per-credit, to indicate how much in USD a customer paid for a single credit in a + # block. This can later be used for revenue recognition. + # + # The following snippet illustrates a sample request body to increment credits + # which will expire in January of 2022. + # + # ```json + # { + # "entry_type": "increment", + # "amount": 100, + # "expiry_date": "2022-12-28", + # "per_unit_cost_basis": "0.20", + # "description": "Purchased 100 credits" + # } + # ``` + # + # Note that by default, Orb will always first increment any _negative_ balance in + # existing blocks before adding the remaining amount to the desired credit block. + # + # ### Invoicing for credits + # + # By default, Orb manipulates the credit ledger but does not charge for credits. + # However, if you pass `invoice_settings` in the body of this request, Orb will + # also generate a one-off invoice for the customer for the credits pre-purchase. + # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges + # on the invoice are calculated by multiplying the cost basis with the number of + # credit units added. + # + # ## Deducting Credits + # + # Orb allows you to deduct credits from a customer by creating an entry of type + # `decrement`. Orb matches the algorithm for automatic deductions for determining + # which credit blocks to decrement from. In the case that the deduction leads to + # multiple ledger entries, the response from this endpoint will be the final + # deduction. Orb also optionally allows specifying a description to assist with + # auditing. + # + # The following snippet illustrates a sample request body to decrement credits. + # + # ```json + # { + # "entry_type": "decrement", + # "amount": 20, + # "description": "Removing excess credits" + # } + # ``` + # + # ## Changing credits expiry + # + # If you'd like to change when existing credits expire, you should create a ledger + # entry of type `expiration_change`. For this entry, the required parameter + # `expiry_date` identifies the _originating_ block, and the required parameter + # `target_expiry_date` identifies when the transferred credits should now expire. + # A new credit block will be created with expiry date `target_expiry_date`, with + # the same cost basis data as the original credit block, if present. + # + # Note that the balance of the block with the given `expiry_date` must be at least + # equal to the desired transfer amount determined by the `amount` parameter. + # + # The following snippet illustrates a sample request body to extend the expiration + # date of credits by one year: + # + # ```json + # { + # "entry_type": "expiration_change", + # "amount": 10, + # "expiry_date": "2022-12-28", + # "block_id": "UiUhFWeLHPrBY4Ad", + # "target_expiry_date": "2023-12-28", + # "description": "Extending credit validity" + # } + # ``` + # + # ## Voiding credits + # + # If you'd like to void a credit block, create a ledger entry of type `void`. For + # this entry, `block_id` is required to identify the block, and `amount` indicates + # how many credits to void, up to the block's initial balance. Pass in a + # `void_reason` of `refund` if the void is due to a refund. + # + # ## Amendment + # + # If you'd like to undo a decrement on a credit block, create a ledger entry of + # type `amendment`. For this entry, `block_id` is required to identify the block + # that was originally decremented from, and `amount` indicates how many credits to + # return to the customer, up to the block's initial balance. # # @overload create_entry(customer_id, amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {}) # @@ -265,115 +265,115 @@ def create_entry(customer_id, params) end # This endpoint allows you to create a new ledger entry for a specified customer's - # balance. This can be used to increment balance, deduct credits, and change the - # expiry date of existing credits. - # - # ## Effects of adding a ledger entry - # - # 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) - # will return a credit block that represents the changes (i.e. balance changes - # or transfers). - # 2. A ledger entry will be added to the credits ledger for this customer, and - # therefore returned in the - # [View Credits Ledger](fetch-customer-credits-ledger) response as well as - # serialized in the response to this request. In the case of deductions without - # a specified block, multiple ledger entries may be created if the deduction - # spans credit blocks. - # 3. If `invoice_settings` is specified, an invoice will be created that reflects - # the cost of the credits (based on `amount` and `per_unit_cost_basis`). - # - # ## Adding credits - # - # Adding credits is done by creating an entry of type `increment`. This requires - # the caller to specify a number of credits as well as an optional expiry date in - # `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with - # auditing. When adding credits, the caller can also specify a cost basis - # per-credit, to indicate how much in USD a customer paid for a single credit in a - # block. This can later be used for revenue recognition. - # - # The following snippet illustrates a sample request body to increment credits - # which will expire in January of 2022. - # - # ```json - # { - # "entry_type": "increment", - # "amount": 100, - # "expiry_date": "2022-12-28", - # "per_unit_cost_basis": "0.20", - # "description": "Purchased 100 credits" - # } - # ``` - # - # Note that by default, Orb will always first increment any _negative_ balance in - # existing blocks before adding the remaining amount to the desired credit block. - # - # ### Invoicing for credits - # - # By default, Orb manipulates the credit ledger but does not charge for credits. - # However, if you pass `invoice_settings` in the body of this request, Orb will - # also generate a one-off invoice for the customer for the credits pre-purchase. - # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges - # on the invoice are calculated by multiplying the cost basis with the number of - # credit units added. - # - # ## Deducting Credits - # - # Orb allows you to deduct credits from a customer by creating an entry of type - # `decrement`. Orb matches the algorithm for automatic deductions for determining - # which credit blocks to decrement from. In the case that the deduction leads to - # multiple ledger entries, the response from this endpoint will be the final - # deduction. Orb also optionally allows specifying a description to assist with - # auditing. - # - # The following snippet illustrates a sample request body to decrement credits. - # - # ```json - # { - # "entry_type": "decrement", - # "amount": 20, - # "description": "Removing excess credits" - # } - # ``` - # - # ## Changing credits expiry - # - # If you'd like to change when existing credits expire, you should create a ledger - # entry of type `expiration_change`. For this entry, the required parameter - # `expiry_date` identifies the _originating_ block, and the required parameter - # `target_expiry_date` identifies when the transferred credits should now expire. - # A new credit block will be created with expiry date `target_expiry_date`, with - # the same cost basis data as the original credit block, if present. - # - # Note that the balance of the block with the given `expiry_date` must be at least - # equal to the desired transfer amount determined by the `amount` parameter. - # - # The following snippet illustrates a sample request body to extend the expiration - # date of credits by one year: - # - # ```json - # { - # "entry_type": "expiration_change", - # "amount": 10, - # "expiry_date": "2022-12-28", - # "block_id": "UiUhFWeLHPrBY4Ad", - # "target_expiry_date": "2023-12-28", - # "description": "Extending credit validity" - # } - # ``` - # - # ## Voiding credits - # - # If you'd like to void a credit block, create a ledger entry of type `void`. For - # this entry, `block_id` is required to identify the block, and `amount` indicates - # how many credits to void, up to the block's initial balance. Pass in a - # `void_reason` of `refund` if the void is due to a refund. - # - # ## Amendment - # - # If you'd like to undo a decrement on a credit block, create a ledger entry of - # type `amendment`. For this entry, `block_id` is required to identify the block - # that was originally decremented from, and `amount` indicates how many credits to - # return to the customer, up to the block's initial balance. + # balance. This can be used to increment balance, deduct credits, and change the + # expiry date of existing credits. + # + # ## Effects of adding a ledger entry + # + # 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) + # will return a credit block that represents the changes (i.e. balance changes + # or transfers). + # 2. A ledger entry will be added to the credits ledger for this customer, and + # therefore returned in the + # [View Credits Ledger](fetch-customer-credits-ledger) response as well as + # serialized in the response to this request. In the case of deductions without + # a specified block, multiple ledger entries may be created if the deduction + # spans credit blocks. + # 3. If `invoice_settings` is specified, an invoice will be created that reflects + # the cost of the credits (based on `amount` and `per_unit_cost_basis`). + # + # ## Adding credits + # + # Adding credits is done by creating an entry of type `increment`. This requires + # the caller to specify a number of credits as well as an optional expiry date in + # `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with + # auditing. When adding credits, the caller can also specify a cost basis + # per-credit, to indicate how much in USD a customer paid for a single credit in a + # block. This can later be used for revenue recognition. + # + # The following snippet illustrates a sample request body to increment credits + # which will expire in January of 2022. + # + # ```json + # { + # "entry_type": "increment", + # "amount": 100, + # "expiry_date": "2022-12-28", + # "per_unit_cost_basis": "0.20", + # "description": "Purchased 100 credits" + # } + # ``` + # + # Note that by default, Orb will always first increment any _negative_ balance in + # existing blocks before adding the remaining amount to the desired credit block. + # + # ### Invoicing for credits + # + # By default, Orb manipulates the credit ledger but does not charge for credits. + # However, if you pass `invoice_settings` in the body of this request, Orb will + # also generate a one-off invoice for the customer for the credits pre-purchase. + # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges + # on the invoice are calculated by multiplying the cost basis with the number of + # credit units added. + # + # ## Deducting Credits + # + # Orb allows you to deduct credits from a customer by creating an entry of type + # `decrement`. Orb matches the algorithm for automatic deductions for determining + # which credit blocks to decrement from. In the case that the deduction leads to + # multiple ledger entries, the response from this endpoint will be the final + # deduction. Orb also optionally allows specifying a description to assist with + # auditing. + # + # The following snippet illustrates a sample request body to decrement credits. + # + # ```json + # { + # "entry_type": "decrement", + # "amount": 20, + # "description": "Removing excess credits" + # } + # ``` + # + # ## Changing credits expiry + # + # If you'd like to change when existing credits expire, you should create a ledger + # entry of type `expiration_change`. For this entry, the required parameter + # `expiry_date` identifies the _originating_ block, and the required parameter + # `target_expiry_date` identifies when the transferred credits should now expire. + # A new credit block will be created with expiry date `target_expiry_date`, with + # the same cost basis data as the original credit block, if present. + # + # Note that the balance of the block with the given `expiry_date` must be at least + # equal to the desired transfer amount determined by the `amount` parameter. + # + # The following snippet illustrates a sample request body to extend the expiration + # date of credits by one year: + # + # ```json + # { + # "entry_type": "expiration_change", + # "amount": 10, + # "expiry_date": "2022-12-28", + # "block_id": "UiUhFWeLHPrBY4Ad", + # "target_expiry_date": "2023-12-28", + # "description": "Extending credit validity" + # } + # ``` + # + # ## Voiding credits + # + # If you'd like to void a credit block, create a ledger entry of type `void`. For + # this entry, `block_id` is required to identify the block, and `amount` indicates + # how many credits to void, up to the block's initial balance. Pass in a + # `void_reason` of `refund` if the void is due to a refund. + # + # ## Amendment + # + # If you'd like to undo a decrement on a credit block, create a ledger entry of + # type `amendment`. For this entry, `block_id` is required to identify the block + # that was originally decremented from, and `amount` indicates how many credits to + # return to the customer, up to the block's initial balance. # # @overload create_entry_by_external_id(external_customer_id, amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {}) # @@ -408,86 +408,86 @@ def create_entry_by_external_id(external_customer_id, params) end # The credits ledger provides _auditing_ functionality over Orb's credits system - # with a list of actions that have taken place to modify a customer's credit - # balance. This [paginated endpoint](/api-reference/pagination) lists these - # entries, starting from the most recent ledger entry. + # with a list of actions that have taken place to modify a customer's credit + # balance. This [paginated endpoint](/api-reference/pagination) lists these + # entries, starting from the most recent ledger entry. # - # More details on using Orb's real-time credit feature are - # [here](/product-catalog/prepurchase). + # More details on using Orb's real-time credit feature are + # [here](/product-catalog/prepurchase). # - # There are four major types of modifications to credit balance, detailed below. + # There are four major types of modifications to credit balance, detailed below. # - # ## Increment + # ## Increment # - # Credits (which optionally expire on a future date) can be added via the API - # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action - # will always contain the total eligible starting and ending balance for the - # customer at the time the entry was added to the ledger. + # Credits (which optionally expire on a future date) can be added via the API + # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action + # will always contain the total eligible starting and ending balance for the + # customer at the time the entry was added to the ledger. # - # ## Decrement + # ## Decrement # - # Deductions can occur as a result of an API call to create a ledger entry (see - # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of - # incurring usage. Both ledger entries present the `decrement` entry type. + # Deductions can occur as a result of an API call to create a ledger entry (see + # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of + # incurring usage. Both ledger entries present the `decrement` entry type. # - # As usage for a customer is reported into Orb, credits may be deducted according - # to the customer's plan configuration. An automated deduction of this type will - # result in a ledger entry, also with a starting and ending balance. In order to - # provide better tracing capabilities for automatic deductions, Orb always - # associates each automatic deduction with the `event_id` at the time of - # ingestion, used to pinpoint _why_ credit deduction took place and to ensure that - # credits are never deducted without an associated usage event. + # As usage for a customer is reported into Orb, credits may be deducted according + # to the customer's plan configuration. An automated deduction of this type will + # result in a ledger entry, also with a starting and ending balance. In order to + # provide better tracing capabilities for automatic deductions, Orb always + # associates each automatic deduction with the `event_id` at the time of + # ingestion, used to pinpoint _why_ credit deduction took place and to ensure that + # credits are never deducted without an associated usage event. # - # By default, Orb uses an algorithm that automatically deducts from the _soonest - # expiring credit block_ first in order to ensure that all credits are utilized - # appropriately. As an example, if trial credits with an expiration date of 2 - # weeks from now are present for a customer, they will be used before any - # deductions take place from a non-expiring credit block. + # By default, Orb uses an algorithm that automatically deducts from the _soonest + # expiring credit block_ first in order to ensure that all credits are utilized + # appropriately. As an example, if trial credits with an expiration date of 2 + # weeks from now are present for a customer, they will be used before any + # deductions take place from a non-expiring credit block. # - # If there are multiple blocks with the same expiration date, Orb will deduct from - # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost - # basis before paid credits with a $5.00 cost basis). + # If there are multiple blocks with the same expiration date, Orb will deduct from + # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost + # basis before paid credits with a $5.00 cost basis). # - # It's also possible for a single usage event's deduction to _span_ credit blocks. - # In this case, Orb will deduct from the next block, ending at the credit block - # which consists of unexpiring credits. Each of these deductions will lead to a - # _separate_ ledger entry, one per credit block that is deducted from. By default, - # the customer's total credit balance in Orb can be negative as a result of a - # decrement. + # It's also possible for a single usage event's deduction to _span_ credit blocks. + # In this case, Orb will deduct from the next block, ending at the credit block + # which consists of unexpiring credits. Each of these deductions will lead to a + # _separate_ ledger entry, one per credit block that is deducted from. By default, + # the customer's total credit balance in Orb can be negative as a result of a + # decrement. # - # ## Expiration change + # ## Expiration change # - # The expiry of credits can be changed as a result of the API (See - # [Add Ledger Entry](create-ledger-entry)). This will create a ledger entry that - # specifies the balance as well as the initial and target expiry dates. + # The expiry of credits can be changed as a result of the API (See + # [Add Ledger Entry](create-ledger-entry)). This will create a ledger entry that + # specifies the balance as well as the initial and target expiry dates. # - # Note that for this entry type, `starting_balance` will equal `ending_balance`, - # and the `amount` represents the balance transferred. The credit block linked to - # the ledger entry is the source credit block from which there was an expiration - # change + # Note that for this entry type, `starting_balance` will equal `ending_balance`, + # and the `amount` represents the balance transferred. The credit block linked to + # the ledger entry is the source credit block from which there was an expiration + # change # - # ## Credits expiry + # ## Credits expiry # - # When a set of credits expire on pre-set expiration date, the customer's balance - # automatically reflects this change and adds an entry to the ledger indicating - # this event. Note that credit expiry should always happen close to a date - # boundary in the customer's timezone. + # When a set of credits expire on pre-set expiration date, the customer's balance + # automatically reflects this change and adds an entry to the ledger indicating + # this event. Note that credit expiry should always happen close to a date + # boundary in the customer's timezone. # - # ## Void initiated + # ## Void initiated # - # Credit blocks can be voided via the API. The `amount` on this entry corresponds - # to the number of credits that were remaining in the block at time of void. - # `void_reason` will be populated if the void is created with a reason. + # Credit blocks can be voided via the API. The `amount` on this entry corresponds + # to the number of credits that were remaining in the block at time of void. + # `void_reason` will be populated if the void is created with a reason. # - # ## Void + # ## Void # - # When a set of credits is voided, the customer's balance automatically reflects - # this change and adds an entry to the ledger indicating this event. + # When a set of credits is voided, the customer's balance automatically reflects + # this change and adds an entry to the ledger indicating this event. # - # ## Amendment + # ## Amendment # - # When credits are added to a customer's balance as a result of a correction, this - # entry will be added to the ledger to indicate the adjustment of credits. + # When credits are added to a customer's balance as a result of a correction, this + # entry will be added to the ledger to indicate the adjustment of credits. # # @overload list_by_external_id(external_customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {}) # diff --git a/lib/orb/resources/customers/credits/top_ups.rb b/lib/orb/resources/customers/credits/top_ups.rb index 6b4f1da9..7ca4a7af 100644 --- a/lib/orb/resources/customers/credits/top_ups.rb +++ b/lib/orb/resources/customers/credits/top_ups.rb @@ -6,12 +6,12 @@ class Customers class Credits class TopUps # This endpoint allows you to create a new top-up for a specified customer's - # balance. While this top-up is active, the customer's balance will added in - # increments of the specified amount whenever the balance reaches the specified - # threshold. + # balance. While this top-up is active, the customer's balance will added in + # increments of the specified amount whenever the balance reaches the specified + # threshold. # - # If a top-up already exists for this customer in the same currency, the existing - # top-up will be replaced. + # If a top-up already exists for this customer in the same currency, the existing + # top-up will be replaced. # # @overload create(customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {}) # @@ -65,7 +65,7 @@ def list(customer_id, params = {}) end # This deactivates the top-up and voids any invoices associated with pending - # credit blocks purchased through the top-up. + # credit blocks purchased through the top-up. # # @overload delete(top_up_id, customer_id:, request_options: {}) # @@ -91,12 +91,12 @@ def delete(top_up_id, params) end # This endpoint allows you to create a new top-up for a specified customer's - # balance. While this top-up is active, the customer's balance will added in - # increments of the specified amount whenever the balance reaches the specified - # threshold. + # balance. While this top-up is active, the customer's balance will added in + # increments of the specified amount whenever the balance reaches the specified + # threshold. # - # If a top-up already exists for this customer in the same currency, the existing - # top-up will be replaced. + # If a top-up already exists for this customer in the same currency, the existing + # top-up will be replaced. # # @overload create_by_external_id(external_customer_id, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {}) # @@ -126,7 +126,7 @@ def create_by_external_id(external_customer_id, params) end # This deactivates the top-up and voids any invoices associated with pending - # credit blocks purchased through the top-up. + # credit blocks purchased through the top-up. # # @overload delete_by_external_id(top_up_id, external_customer_id:, request_options: {}) # diff --git a/lib/orb/resources/dimensional_price_groups.rb b/lib/orb/resources/dimensional_price_groups.rb index b29ec736..764711ea 100644 --- a/lib/orb/resources/dimensional_price_groups.rb +++ b/lib/orb/resources/dimensional_price_groups.rb @@ -7,13 +7,13 @@ class DimensionalPriceGroups attr_reader :external_dimensional_price_group_id # A dimensional price group is used to partition the result of a billable metric - # by a set of dimensions. Prices in a price group must specify the parition used - # to derive their usage. + # by a set of dimensions. Prices in a price group must specify the parition used + # to derive their usage. # - # For example, suppose we have a billable metric that measures the number of - # widgets used and we want to charge differently depending on the color of the - # widget. We can create a price group with a dimension "color" and two prices: one - # that charges $10 per red widget and one that charges $20 per blue widget. + # For example, suppose we have a billable metric that measures the number of + # widgets used and we want to charge differently depending on the color of the + # widget. We can create a price group with a dimension "color" and two prices: one + # that charges $10 per red widget and one that charges $20 per blue widget. # # @overload create(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {}) # diff --git a/lib/orb/resources/events.rb b/lib/orb/resources/events.rb index 75a07c80..f55004e4 100644 --- a/lib/orb/resources/events.rb +++ b/lib/orb/resources/events.rb @@ -10,50 +10,50 @@ class Events attr_reader :volume # This endpoint is used to amend a single usage event with a given `event_id`. - # `event_id` refers to the `idempotency_key` passed in during ingestion. The event - # will maintain its existing `event_id` after the amendment. - # - # This endpoint will mark the existing event as ignored, and Orb will only use the - # new event passed in the body of this request as the source of truth for that - # `event_id`. Note that a single event can be amended any number of times, so the - # same event can be overwritten in subsequent calls to this endpoint. Only a - # single event with a given `event_id` will be considered the source of truth at - # any given time. - # - # This is a powerful and audit-safe mechanism to retroactively update a single - # event in cases where you need to: - # - # - update an event with new metadata as you iterate on your pricing model - # - update an event based on the result of an external API call (e.g. call to a - # payment gateway succeeded or failed) - # - # This amendment API is always audit-safe. The process will still retain the - # original event, though it will be ignored for billing calculations. For auditing - # and data fidelity purposes, Orb never overwrites or permanently deletes ingested - # usage data. - # - # ## Request validation - # - # - The `timestamp` of the new event must match the `timestamp` of the existing - # event already ingested. As with ingestion, all timestamps must be sent in - # ISO8601 format with UTC timezone offset. - # - The `customer_id` or `external_customer_id` of the new event must match the - # `customer_id` or `external_customer_id` of the existing event already - # ingested. Exactly one of `customer_id` and `external_customer_id` should be - # specified, and similar to ingestion, the ID must identify a Customer resource - # within Orb. Unlike ingestion, for event amendment, we strictly enforce that - # the Customer must be in the Orb system, even during the initial integration - # period. We do not allow updating the `Customer` an event is associated with. - # - Orb does not accept an `idempotency_key` with the event in this endpoint, - # since this request is by design idempotent. On retryable errors, you should - # retry the request and assume the amendment operation has not succeeded until - # receipt of a 2xx. - # - The event's `timestamp` must fall within the customer's current subscription's - # billing period, or within the grace period of the customer's current - # subscription's previous billing period. - # - By default, no more than 100 events can be amended for a single customer in a - # 100 day period. For higher volume updates, consider using the - # [event backfill](create-backfill) endpoint. + # `event_id` refers to the `idempotency_key` passed in during ingestion. The event + # will maintain its existing `event_id` after the amendment. + # + # This endpoint will mark the existing event as ignored, and Orb will only use the + # new event passed in the body of this request as the source of truth for that + # `event_id`. Note that a single event can be amended any number of times, so the + # same event can be overwritten in subsequent calls to this endpoint. Only a + # single event with a given `event_id` will be considered the source of truth at + # any given time. + # + # This is a powerful and audit-safe mechanism to retroactively update a single + # event in cases where you need to: + # + # - update an event with new metadata as you iterate on your pricing model + # - update an event based on the result of an external API call (e.g. call to a + # payment gateway succeeded or failed) + # + # This amendment API is always audit-safe. The process will still retain the + # original event, though it will be ignored for billing calculations. For auditing + # and data fidelity purposes, Orb never overwrites or permanently deletes ingested + # usage data. + # + # ## Request validation + # + # - The `timestamp` of the new event must match the `timestamp` of the existing + # event already ingested. As with ingestion, all timestamps must be sent in + # ISO8601 format with UTC timezone offset. + # - The `customer_id` or `external_customer_id` of the new event must match the + # `customer_id` or `external_customer_id` of the existing event already + # ingested. Exactly one of `customer_id` and `external_customer_id` should be + # specified, and similar to ingestion, the ID must identify a Customer resource + # within Orb. Unlike ingestion, for event amendment, we strictly enforce that + # the Customer must be in the Orb system, even during the initial integration + # period. We do not allow updating the `Customer` an event is associated with. + # - Orb does not accept an `idempotency_key` with the event in this endpoint, + # since this request is by design idempotent. On retryable errors, you should + # retry the request and assume the amendment operation has not succeeded until + # receipt of a 2xx. + # - The event's `timestamp` must fall within the customer's current subscription's + # billing period, or within the grace period of the customer's current + # subscription's previous billing period. + # - By default, no more than 100 events can be amended for a single customer in a + # 100 day period. For higher volume updates, consider using the + # [event backfill](create-backfill) endpoint. # # @overload update(event_id, event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {}) # @@ -80,45 +80,45 @@ def update(event_id, params) end # This endpoint is used to deprecate a single usage event with a given `event_id`. - # `event_id` refers to the `idempotency_key` passed in during ingestion. - # - # This endpoint will mark the existing event as ignored. Note that if you attempt - # to re-ingest an event with the same `event_id` as a deprecated event, Orb will - # return an error. - # - # This is a powerful and audit-safe mechanism to retroactively deprecate a single - # event in cases where you need to: - # - # - no longer bill for an event that was improperly reported - # - no longer bill for an event based on the result of an external API call (e.g. - # call to a payment gateway failed and the user should not be billed) - # - # If you want to only change specific properties of an event, but keep the event - # as part of the billing calculation, use the [Amend event](amend-event) endpoint - # instead. - # - # This API is always audit-safe. The process will still retain the deprecated - # event, though it will be ignored for billing calculations. For auditing and data - # fidelity purposes, Orb never overwrites or permanently deletes ingested usage - # data. - # - # ## Request validation - # - # - Orb does not accept an `idempotency_key` with the event in this endpoint, - # since this request is by design idempotent. On retryable errors, you should - # retry the request and assume the deprecation operation has not succeeded until - # receipt of a 2xx. - # - The event's `timestamp` must fall within the customer's current subscription's - # billing period, or within the grace period of the customer's current - # subscription's previous billing period. Orb does not allow deprecating events - # for billing periods that have already invoiced customers. - # - The `customer_id` or the `external_customer_id` of the original event - # ingestion request must identify a Customer resource within Orb, even if this - # event was ingested during the initial integration period. We do not allow - # deprecating events for customers not in the Orb system. - # - By default, no more than 100 events can be deprecated for a single customer in - # a 100 day period. For higher volume updates, consider using the - # [event backfill](create-backfill) endpoint. + # `event_id` refers to the `idempotency_key` passed in during ingestion. + # + # This endpoint will mark the existing event as ignored. Note that if you attempt + # to re-ingest an event with the same `event_id` as a deprecated event, Orb will + # return an error. + # + # This is a powerful and audit-safe mechanism to retroactively deprecate a single + # event in cases where you need to: + # + # - no longer bill for an event that was improperly reported + # - no longer bill for an event based on the result of an external API call (e.g. + # call to a payment gateway failed and the user should not be billed) + # + # If you want to only change specific properties of an event, but keep the event + # as part of the billing calculation, use the [Amend event](amend-event) endpoint + # instead. + # + # This API is always audit-safe. The process will still retain the deprecated + # event, though it will be ignored for billing calculations. For auditing and data + # fidelity purposes, Orb never overwrites or permanently deletes ingested usage + # data. + # + # ## Request validation + # + # - Orb does not accept an `idempotency_key` with the event in this endpoint, + # since this request is by design idempotent. On retryable errors, you should + # retry the request and assume the deprecation operation has not succeeded until + # receipt of a 2xx. + # - The event's `timestamp` must fall within the customer's current subscription's + # billing period, or within the grace period of the customer's current + # subscription's previous billing period. Orb does not allow deprecating events + # for billing periods that have already invoiced customers. + # - The `customer_id` or the `external_customer_id` of the original event + # ingestion request must identify a Customer resource within Orb, even if this + # event was ingested during the initial integration period. We do not allow + # deprecating events for customers not in the Orb system. + # - By default, no more than 100 events can be deprecated for a single customer in + # a 100 day period. For higher volume updates, consider using the + # [event backfill](create-backfill) endpoint. # # @overload deprecate(event_id, request_options: {}) # @@ -139,208 +139,208 @@ def deprecate(event_id, params = {}) # Orb's event ingestion model and API is designed around two core principles: # - # 1. **Data fidelity**: The accuracy of your billing model depends on a robust - # foundation of events. Orb's API protocol encourages usage patterns that - # ensure that your data is consistently complete and correct. - # 2. **Fast integration**: Sending events into Orb requires no tedious setup steps - # or explicit field schema for your event shape, making it instant to start - # streaming in usage in real-time. - # - # ## Event shape - # - # Events are the starting point for all usage calculations in the system, and are - # simple at their core: - # - # ```ts - # { - # // customer_id and external_customer_id are used to - # // attribute usage to a given Customer. Exactly one of these - # // should be specified in a given ingestion event. - # - # // `customer_id` is the Orb generated identifier for the Customer, - # // which is returned from the Create customer API call. - # customer_id: string, - # - # // external_customer_id is an alternate identifier which is associated - # // with a Customer at creation time. This is treated as an alias for - # // customer_id, and is usually set to an identifier native to your system. - # external_customer_id: string, - # - # // A string name identifying the event, usually a usage - # // action. By convention, this should not contain any whitespace. - # event_name: string, - # - # // An ISO 8601 format date with no timezone offset. - # // This should represent the time that usage occurred - # // and is important to attribute usage to a given - # // billing period. See the notes below on determining the timestamp. - # // e.g. 2020-12-09T16:09:53Z - # timestamp: string, - # - # // A unique value, generated by the client, that is - # // used to de-duplicate events. - # // Exactly one event with a given - # // idempotency key will be ingested, which allows for - # // safe request retries. - # idempotency_key: string - # - # // Optional custom metadata to attach to the event. - # // This might include a numeric value used for aggregation, - # // or a string/boolean value used for filtering. - # // The schema of this dictionary need not be pre-declared, and - # // properties can be added at any time. - # properties: { - # [key: string]?: string | number | boolean, - # }, - # } - # ``` - # - # ## Required fields - # - # Because events streamed to Orb are meant to be as flexible as possible, there - # are only a few required fields in every event. - # - # - We recommend that `idempotency_key` are unique strings that you generated with - # V4 UUIDs, but only require that they uniquely identify an event (i.e. don’t - # collide). - # - The `timestamp` field in the event body will be used to determine which - # billable period a given event falls into. For example, with a monthly billing - # cycle starting from the first of December, Orb will calculate metrics based on - # events that fall into the range - # `12-01 00:00:00 <= timestamp < 01-01 00:00:00`. - # - # ## Logging metadata - # - # Orb allows tagging events with metadata using a flexible properties dictionary. - # Since Orb does not enforce a rigid schema for this field-set, key-value pairs - # can be added dynamically as your events evolve. - # - # This dictionary can be helpful for a wide variety of use cases: - # - # - Numeric properties on events like `compute_time_ms` can later be inputs to our - # flexible query engine to determine usage. - # - Logging a region or cluster with each event can help you provide customers - # more granular visibility into their usage. - # - If you are using matrix pricing and matching a matrix price key with a - # property, you should ensure the value for that property is sent as a string. - # - # We encourage logging this metadata with an eye towards future use cases to - # ensure full coverage for historical data. The datatype of the value in the - # properties dictionary is important for metric creation from an event source. - # Values that you wish to numerically aggregate should be of numeric type in the - # event. - # - # ## Determining event timestamp - # - # For cases where usage is being reported in real time as it is occurring, - # timestamp should correspond to the time that usage occurred. - # - # In cases where usage is reported in aggregate for a historical timeframe at a - # regular interval, we recommend setting the event `timestamp` to the midpoint of - # the interval. As an example, if you have an hourly reporter that sends data once - # an hour for the previous hour of usage, setting the `timestamp` to the half-hour - # mark will ensure that the usage is counted within the correct period. - # - # Note that other time-related fields (e.g. time elapsed) can be added to the - # properties dictionary as necessary. - # - # In cases where usage is reported in aggregate for a historical timeframe, the - # timestamp must be within the grace period set for your account. Events with - # `timestamp < current_time - grace_period` will not be accepted as a valid event, - # and will throw validation errors. Enforcing the grace period enables Orb to - # accurately map usage to the correct billing cycle and ensure that all usage is - # billed for in the corresponding billing period. - # - # In general, Orb does not expect events with future dated timestamps. In cases - # where the timestamp is at least 24 hours ahead of the current time, the event - # will not be accepted as a valid event, and will throw validation errors. - # - # ## Event validation - # - # Orb’s validation ensures that you recognize errors in your events as quickly as - # possible, and the API provides informative error messages to help you fix - # problems quickly. - # - # We validate the following: - # - # - Exactly one of `customer_id` and `external_customer_id` should be specified. - # - If the `customer_id` is specified, the customer in Orb must exist. - # - If the `external_customer_id` is specified, the customer in Orb does not need - # to exist. Events will be attributed to any future customers with the - # `external_customer_id` on subscription creation. - # - `timestamp` must conform to ISO 8601 and represent a timestamp at most 1 hour - # in the future. This timestamp should be sent in UTC timezone (no timezone - # offset). - # - # ## Idempotency and retry semantics - # - # Orb's idempotency guarantees allow you to implement safe retry logic in the - # event of network or machine failures, ensuring data fidelity. Each event in the - # request payload is associated with an idempotency key, and Orb guarantees that a - # single idempotency key will be successfully ingested at most once. Note that - # when Orb encounters events with duplicate idempotency keys and differing event - # bodies in a batch of events, the entire batch will be rejected. - # - # - Successful responses return a 200 HTTP status code. The response contains - # information about previously processed events. - # - Requests that return a `4xx` HTTP status code indicate a payload error and - # contain at least one event with a validation failure. An event with a - # validation failure can be re-sent to the ingestion endpoint (after the payload - # is fixed) with the original idempotency key since that key is not marked as - # processed. - # - Requests that return a `5xx` HTTP status code indicate a server-side failure. - # These requests should be retried in their entirety. - # - # ## API usage and limits - # - # The ingestion API is designed made for real-time streaming ingestion and - # architected for high throughput. Even if events are later deemed unnecessary or - # filtered out, we encourage you to log them to Orb if they may be relevant to - # billing calculations in the future. - # - # To take advantage of the real-time features of the Orb platform and avoid any - # chance of dropped events by producers, we recommend reporting events to Orb - # frequently. Optionally, events can also be briefly aggregated at the source, as - # this API accepts an array of event bodies. - # - # Orb does not currently enforce a hard rate-limit for API usage or a maximum - # request payload size, but please give us a heads up if you’re changing either of - # these factors by an order of magnitude from initial setup. - # - # ## Testing in debug mode - # - # The ingestion API supports a debug mode, which returns additional verbose output - # to indicate which event idempotency keys were newly ingested or duplicates from - # previous requests. To enable this mode, mark `debug=true` as a query parameter. - # - # If `debug=true` is not specified, the response will only contain - # `validation_failed`. Orb will still honor the idempotency guarantees set - # [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all - # cases. - # - # We strongly recommend that you only use debug mode as part of testing your - # initial Orb integration. Once you're ready to switch to production, disable - # debug mode to take advantage of improved performance and maximal throughput. - # - # #### Example: ingestion response with `debug=true` - # - # ```json - # { - # "debug": { - # "duplicate": [], - # "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"] - # }, - # "validation_failed": [] - # } - # ``` - # - # #### Example: ingestion response with `debug=false` - # - # ```json - # { - # "validation_failed": [] - # } - # ``` + # 1. **Data fidelity**: The accuracy of your billing model depends on a robust + # foundation of events. Orb's API protocol encourages usage patterns that + # ensure that your data is consistently complete and correct. + # 2. **Fast integration**: Sending events into Orb requires no tedious setup steps + # or explicit field schema for your event shape, making it instant to start + # streaming in usage in real-time. + # + # ## Event shape + # + # Events are the starting point for all usage calculations in the system, and are + # simple at their core: + # + # ```ts + # { + # // customer_id and external_customer_id are used to + # // attribute usage to a given Customer. Exactly one of these + # // should be specified in a given ingestion event. + # + # // `customer_id` is the Orb generated identifier for the Customer, + # // which is returned from the Create customer API call. + # customer_id: string, + # + # // external_customer_id is an alternate identifier which is associated + # // with a Customer at creation time. This is treated as an alias for + # // customer_id, and is usually set to an identifier native to your system. + # external_customer_id: string, + # + # // A string name identifying the event, usually a usage + # // action. By convention, this should not contain any whitespace. + # event_name: string, + # + # // An ISO 8601 format date with no timezone offset. + # // This should represent the time that usage occurred + # // and is important to attribute usage to a given + # // billing period. See the notes below on determining the timestamp. + # // e.g. 2020-12-09T16:09:53Z + # timestamp: string, + # + # // A unique value, generated by the client, that is + # // used to de-duplicate events. + # // Exactly one event with a given + # // idempotency key will be ingested, which allows for + # // safe request retries. + # idempotency_key: string + # + # // Optional custom metadata to attach to the event. + # // This might include a numeric value used for aggregation, + # // or a string/boolean value used for filtering. + # // The schema of this dictionary need not be pre-declared, and + # // properties can be added at any time. + # properties: { + # [key: string]?: string | number | boolean, + # }, + # } + # ``` + # + # ## Required fields + # + # Because events streamed to Orb are meant to be as flexible as possible, there + # are only a few required fields in every event. + # + # - We recommend that `idempotency_key` are unique strings that you generated with + # V4 UUIDs, but only require that they uniquely identify an event (i.e. don’t + # collide). + # - The `timestamp` field in the event body will be used to determine which + # billable period a given event falls into. For example, with a monthly billing + # cycle starting from the first of December, Orb will calculate metrics based on + # events that fall into the range + # `12-01 00:00:00 <= timestamp < 01-01 00:00:00`. + # + # ## Logging metadata + # + # Orb allows tagging events with metadata using a flexible properties dictionary. + # Since Orb does not enforce a rigid schema for this field-set, key-value pairs + # can be added dynamically as your events evolve. + # + # This dictionary can be helpful for a wide variety of use cases: + # + # - Numeric properties on events like `compute_time_ms` can later be inputs to our + # flexible query engine to determine usage. + # - Logging a region or cluster with each event can help you provide customers + # more granular visibility into their usage. + # - If you are using matrix pricing and matching a matrix price key with a + # property, you should ensure the value for that property is sent as a string. + # + # We encourage logging this metadata with an eye towards future use cases to + # ensure full coverage for historical data. The datatype of the value in the + # properties dictionary is important for metric creation from an event source. + # Values that you wish to numerically aggregate should be of numeric type in the + # event. + # + # ## Determining event timestamp + # + # For cases where usage is being reported in real time as it is occurring, + # timestamp should correspond to the time that usage occurred. + # + # In cases where usage is reported in aggregate for a historical timeframe at a + # regular interval, we recommend setting the event `timestamp` to the midpoint of + # the interval. As an example, if you have an hourly reporter that sends data once + # an hour for the previous hour of usage, setting the `timestamp` to the half-hour + # mark will ensure that the usage is counted within the correct period. + # + # Note that other time-related fields (e.g. time elapsed) can be added to the + # properties dictionary as necessary. + # + # In cases where usage is reported in aggregate for a historical timeframe, the + # timestamp must be within the grace period set for your account. Events with + # `timestamp < current_time - grace_period` will not be accepted as a valid event, + # and will throw validation errors. Enforcing the grace period enables Orb to + # accurately map usage to the correct billing cycle and ensure that all usage is + # billed for in the corresponding billing period. + # + # In general, Orb does not expect events with future dated timestamps. In cases + # where the timestamp is at least 24 hours ahead of the current time, the event + # will not be accepted as a valid event, and will throw validation errors. + # + # ## Event validation + # + # Orb’s validation ensures that you recognize errors in your events as quickly as + # possible, and the API provides informative error messages to help you fix + # problems quickly. + # + # We validate the following: + # + # - Exactly one of `customer_id` and `external_customer_id` should be specified. + # - If the `customer_id` is specified, the customer in Orb must exist. + # - If the `external_customer_id` is specified, the customer in Orb does not need + # to exist. Events will be attributed to any future customers with the + # `external_customer_id` on subscription creation. + # - `timestamp` must conform to ISO 8601 and represent a timestamp at most 1 hour + # in the future. This timestamp should be sent in UTC timezone (no timezone + # offset). + # + # ## Idempotency and retry semantics + # + # Orb's idempotency guarantees allow you to implement safe retry logic in the + # event of network or machine failures, ensuring data fidelity. Each event in the + # request payload is associated with an idempotency key, and Orb guarantees that a + # single idempotency key will be successfully ingested at most once. Note that + # when Orb encounters events with duplicate idempotency keys and differing event + # bodies in a batch of events, the entire batch will be rejected. + # + # - Successful responses return a 200 HTTP status code. The response contains + # information about previously processed events. + # - Requests that return a `4xx` HTTP status code indicate a payload error and + # contain at least one event with a validation failure. An event with a + # validation failure can be re-sent to the ingestion endpoint (after the payload + # is fixed) with the original idempotency key since that key is not marked as + # processed. + # - Requests that return a `5xx` HTTP status code indicate a server-side failure. + # These requests should be retried in their entirety. + # + # ## API usage and limits + # + # The ingestion API is designed made for real-time streaming ingestion and + # architected for high throughput. Even if events are later deemed unnecessary or + # filtered out, we encourage you to log them to Orb if they may be relevant to + # billing calculations in the future. + # + # To take advantage of the real-time features of the Orb platform and avoid any + # chance of dropped events by producers, we recommend reporting events to Orb + # frequently. Optionally, events can also be briefly aggregated at the source, as + # this API accepts an array of event bodies. + # + # Orb does not currently enforce a hard rate-limit for API usage or a maximum + # request payload size, but please give us a heads up if you’re changing either of + # these factors by an order of magnitude from initial setup. + # + # ## Testing in debug mode + # + # The ingestion API supports a debug mode, which returns additional verbose output + # to indicate which event idempotency keys were newly ingested or duplicates from + # previous requests. To enable this mode, mark `debug=true` as a query parameter. + # + # If `debug=true` is not specified, the response will only contain + # `validation_failed`. Orb will still honor the idempotency guarantees set + # [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all + # cases. + # + # We strongly recommend that you only use debug mode as part of testing your + # initial Orb integration. Once you're ready to switch to production, disable + # debug mode to take advantage of improved performance and maximal throughput. + # + # #### Example: ingestion response with `debug=true` + # + # ```json + # { + # "debug": { + # "duplicate": [], + # "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"] + # }, + # "validation_failed": [] + # } + # ``` + # + # #### Example: ingestion response with `debug=false` + # + # ```json + # { + # "validation_failed": [] + # } + # ``` # # @overload ingest(events:, backfill_id: nil, debug: nil, request_options: {}) # @@ -366,20 +366,20 @@ def ingest(params) end # This endpoint returns a filtered set of events for an account in a - # [paginated list format](/api-reference/pagination). + # [paginated list format](/api-reference/pagination). # - # Note that this is a `POST` endpoint rather than a `GET` endpoint because it - # employs a JSON body for search criteria rather than query parameters, allowing - # for a more flexible search syntax. + # Note that this is a `POST` endpoint rather than a `GET` endpoint because it + # employs a JSON body for search criteria rather than query parameters, allowing + # for a more flexible search syntax. # - # Note that a search criteria _must_ be specified. Currently, Orb supports the - # following criteria: + # Note that a search criteria _must_ be specified. Currently, Orb supports the + # following criteria: # - # - `event_ids`: This is an explicit array of IDs to filter by. Note that an - # event's ID is the `idempotency_key` that was originally used for ingestion. + # - `event_ids`: This is an explicit array of IDs to filter by. Note that an + # event's ID is the `idempotency_key` that was originally used for ingestion. # - # By default, Orb will not throw a `404` if no events matched, Orb will return an - # empty array for `data` instead. + # By default, Orb will not throw a `404` if no events matched, Orb will return an + # empty array for `data` instead. # # @overload search(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}) # diff --git a/lib/orb/resources/events/backfills.rb b/lib/orb/resources/events/backfills.rb index 1e8cff8d..4c842e79 100644 --- a/lib/orb/resources/events/backfills.rb +++ b/lib/orb/resources/events/backfills.rb @@ -5,42 +5,42 @@ module Resources class Events class Backfills # Creating the backfill enables adding or replacing past events, even those that - # are older than the ingestion grace period. Performing a backfill in Orb involves - # 3 steps: - # - # 1. Create the backfill, specifying its parameters. - # 2. [Ingest](ingest) usage events, referencing the backfill (query parameter - # `backfill_id`). - # 3. [Close](close-backfill) the backfill, propagating the update in past usage - # throughout Orb. - # - # Changes from a backfill are not reflected until the backfill is closed, so you - # won’t need to worry about your customers seeing partially updated usage data. - # Backfills are also reversible, so you’ll be able to revert a backfill if you’ve - # made a mistake. - # - # This endpoint will return a backfill object, which contains an `id`. That `id` - # can then be used as the `backfill_id` query parameter to the event ingestion - # endpoint to associate ingested events with this backfill. The effects (e.g. - # updated usage graphs) of this backfill will not take place until the backfill is - # closed. - # - # If the `replace_existing_events` is `true`, existing events in the backfill's - # timeframe will be replaced with the newly ingested events associated with the - # backfill. If `false`, newly ingested events will be added to the existing - # events. - # - # If a `customer_id` or `external_customer_id` is specified, the backfill will - # only affect events for that customer. If neither is specified, the backfill will - # affect all customers. - # - # When `replace_existing_events` is `true`, this indicates that existing events in - # the timeframe should no longer be counted towards invoiced usage. In this - # scenario, the parameter `filter` can be optionally added which enables filtering - # using - # [computed properties](/extensibility/advanced-metrics#computed-properties). The - # expressiveness of computed properties allows you to deprecate existing events - # based on both a period of time and specific property values. + # are older than the ingestion grace period. Performing a backfill in Orb involves + # 3 steps: + # + # 1. Create the backfill, specifying its parameters. + # 2. [Ingest](ingest) usage events, referencing the backfill (query parameter + # `backfill_id`). + # 3. [Close](close-backfill) the backfill, propagating the update in past usage + # throughout Orb. + # + # Changes from a backfill are not reflected until the backfill is closed, so you + # won’t need to worry about your customers seeing partially updated usage data. + # Backfills are also reversible, so you’ll be able to revert a backfill if you’ve + # made a mistake. + # + # This endpoint will return a backfill object, which contains an `id`. That `id` + # can then be used as the `backfill_id` query parameter to the event ingestion + # endpoint to associate ingested events with this backfill. The effects (e.g. + # updated usage graphs) of this backfill will not take place until the backfill is + # closed. + # + # If the `replace_existing_events` is `true`, existing events in the backfill's + # timeframe will be replaced with the newly ingested events associated with the + # backfill. If `false`, newly ingested events will be added to the existing + # events. + # + # If a `customer_id` or `external_customer_id` is specified, the backfill will + # only affect events for that customer. If neither is specified, the backfill will + # affect all customers. + # + # When `replace_existing_events` is `true`, this indicates that existing events in + # the timeframe should no longer be counted towards invoiced usage. In this + # scenario, the parameter `filter` can be optionally added which enables filtering + # using + # [computed properties](/extensibility/advanced-metrics#computed-properties). The + # expressiveness of computed properties allows you to deprecate existing events + # based on both a period of time and specific property values. # # @overload create(timeframe_end:, timeframe_start:, close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {}) # @@ -69,11 +69,11 @@ def create(params) # This endpoint returns a list of all backfills in a list format. # - # The list of backfills is ordered starting from the most recently created - # backfill. The response also includes - # [`pagination_metadata`](/api-reference/pagination), which lets the caller - # retrieve the next page of results if they exist. More information about - # pagination can be found in the [Pagination-metadata schema](pagination). + # The list of backfills is ordered starting from the most recently created + # backfill. The response also includes + # [`pagination_metadata`](/api-reference/pagination), which lets the caller + # retrieve the next page of results if they exist. More information about + # pagination can be found in the [Pagination-metadata schema](pagination). # # @overload list(cursor: nil, limit: nil, request_options: {}) # @@ -97,9 +97,9 @@ def list(params = {}) end # Closing a backfill makes the updated usage visible in Orb. Upon closing a - # backfill, Orb will asynchronously reflect the updated usage in invoice amounts - # and usage graphs. Once all of the updates are complete, the backfill's status - # will transition to `reflected`. + # backfill, Orb will asynchronously reflect the updated usage in invoice amounts + # and usage graphs. Once all of the updates are complete, the backfill's status + # will transition to `reflected`. # # @overload close(backfill_id, request_options: {}) # @@ -138,12 +138,12 @@ def fetch(backfill_id, params = {}) end # Reverting a backfill undoes all the effects of closing the backfill. If the - # backfill is reflected, the status will transition to `pending_revert` while the - # effects of the backfill are undone. Once all effects are undone, the backfill - # will transition to `reverted`. + # backfill is reflected, the status will transition to `pending_revert` while the + # effects of the backfill are undone. Once all effects are undone, the backfill + # will transition to `reverted`. # - # If a backfill is reverted before its closed, no usage will be updated as a - # result of the backfill and it will immediately transition to `reverted`. + # If a backfill is reverted before its closed, no usage will be updated as a + # result of the backfill and it will immediately transition to `reverted`. # # @overload revert(backfill_id, request_options: {}) # diff --git a/lib/orb/resources/events/volume.rb b/lib/orb/resources/events/volume.rb index 17d18350..dbc4b441 100644 --- a/lib/orb/resources/events/volume.rb +++ b/lib/orb/resources/events/volume.rb @@ -5,18 +5,18 @@ module Resources class Events class Volume # This endpoint returns the event volume for an account in a - # [paginated list format](/api-reference/pagination). + # [paginated list format](/api-reference/pagination). # - # The event volume is aggregated by the hour and the - # [timestamp](/api-reference/event/ingest-events) field is used to determine which - # hour an event is associated with. Note, this means that late-arriving events - # increment the volume count for the hour window the timestamp is in, not the - # latest hour window. + # The event volume is aggregated by the hour and the + # [timestamp](/api-reference/event/ingest-events) field is used to determine which + # hour an event is associated with. Note, this means that late-arriving events + # increment the volume count for the hour window the timestamp is in, not the + # latest hour window. # - # Each item in the response contains the count of events aggregated by the hour - # where the start and end time are hour-aligned and in UTC. When a specific - # timestamp is passed in for either start or end time, the response includes the - # hours the timestamp falls in. + # Each item in the response contains the count of events aggregated by the hour + # where the start and end time are hour-aligned and in UTC. When a specific + # timestamp is passed in for either start or end time, the response includes the + # hours the timestamp falls in. # # @overload list(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}) # diff --git a/lib/orb/resources/invoice_line_items.rb b/lib/orb/resources/invoice_line_items.rb index afacdf80..0f973aa4 100644 --- a/lib/orb/resources/invoice_line_items.rb +++ b/lib/orb/resources/invoice_line_items.rb @@ -4,7 +4,7 @@ module Orb module Resources class InvoiceLineItems # This creates a one-off fixed fee invoice line item on an Invoice. This can only - # be done for invoices that are in a `draft` status. + # be done for invoices that are in a `draft` status. # # @overload create(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {}) # diff --git a/lib/orb/resources/invoices.rb b/lib/orb/resources/invoices.rb index d975114b..32905168 100644 --- a/lib/orb/resources/invoices.rb +++ b/lib/orb/resources/invoices.rb @@ -34,10 +34,10 @@ def create(params) end # This endpoint allows you to update the `metadata` property on an invoice. If you - # pass null for the metadata value, it will clear any existing metadata for that - # invoice. + # pass null for the metadata value, it will clear any existing metadata for that + # invoice. # - # `metadata` can be modified regardless of invoice state. + # `metadata` can be modified regardless of invoice state. # # @overload update(invoice_id, metadata: nil, request_options: {}) # @@ -60,18 +60,18 @@ def update(invoice_id, params = {}) end # This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an - # account in a list format. + # account in a list format. # - # The list of invoices is ordered starting from the most recently issued invoice - # date. The response also includes - # [`pagination_metadata`](/api-reference/pagination), which lets the caller - # retrieve the next page of results if they exist. + # The list of invoices is ordered starting from the most recently issued invoice + # date. The response also includes + # [`pagination_metadata`](/api-reference/pagination), which lets the caller + # retrieve the next page of results if they exist. # - # By default, this only returns invoices that are `issued`, `paid`, or `synced`. + # By default, this only returns invoices that are `issued`, `paid`, or `synced`. # - # When fetching any `draft` invoices, this returns the last-computed invoice - # values for each draft invoice, which may not always be up-to-date since Orb - # regularly refreshes invoices asynchronously. + # When fetching any `draft` invoices, this returns the last-computed invoice + # values for each draft invoice, which may not always be up-to-date since Orb + # regularly refreshes invoices asynchronously. # # @overload list(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {}) # @@ -121,7 +121,7 @@ def list(params = {}) end # This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an - # identifier. + # identifier. # # @overload fetch(invoice_id, request_options: {}) # @@ -141,8 +141,8 @@ def fetch(invoice_id, params = {}) end # This endpoint can be used to fetch the upcoming - # [invoice](/core-concepts#invoice) for the current billing period given a - # subscription. + # [invoice](/core-concepts#invoice) for the current billing period given a + # subscription. # # @overload fetch_upcoming(subscription_id:, request_options: {}) # @@ -164,11 +164,11 @@ def fetch_upcoming(params) end # This endpoint allows an eligible invoice to be issued manually. This is only - # possible with invoices where status is `draft`, `will_auto_issue` is false, and - # an `eligible_to_issue_at` is a time in the past. Issuing an invoice could - # possibly trigger side effects, some of which could be customer-visible (e.g. - # sending emails, auto-collecting payment, syncing the invoice to external - # providers, etc). + # possible with invoices where status is `draft`, `will_auto_issue` is false, and + # an `eligible_to_issue_at` is a time in the past. Issuing an invoice could + # possibly trigger side effects, some of which could be customer-visible (e.g. + # sending emails, auto-collecting payment, syncing the invoice to external + # providers, etc). # # @overload issue(invoice_id, synchronous: nil, request_options: {}) # @@ -191,7 +191,7 @@ def issue(invoice_id, params = {}) end # This endpoint allows an invoice's status to be set the `paid` status. This can - # only be done to invoices that are in the `issued` status. + # only be done to invoices that are in the `issued` status. # # @overload mark_paid(invoice_id, payment_received_date:, external_id: nil, notes: nil, request_options: {}) # @@ -216,7 +216,7 @@ def mark_paid(invoice_id, params) end # This endpoint collects payment for an invoice using the customer's default - # payment method. This action can only be taken on invoices with status "issued". + # payment method. This action can only be taken on invoices with status "issued". # # @overload pay(invoice_id, request_options: {}) # @@ -236,16 +236,16 @@ def pay(invoice_id, params = {}) end # This endpoint allows an invoice's status to be set the `void` status. This can - # only be done to invoices that are in the `issued` status. + # only be done to invoices that are in the `issued` status. # - # If the associated invoice has used the customer balance to change the amount - # due, the customer balance operation will be reverted. For example, if the - # invoice used $10 of customer balance, that amount will be added back to the - # customer balance upon voiding. + # If the associated invoice has used the customer balance to change the amount + # due, the customer balance operation will be reverted. For example, if the + # invoice used $10 of customer balance, that amount will be added back to the + # customer balance upon voiding. # - # If the invoice was used to purchase a credit block, but the invoice is not yet - # paid, the credit block will be voided. If the invoice was created due to a - # top-up, the top-up will be disabled. + # If the invoice was used to purchase a credit block, but the invoice is not yet + # paid, the credit block will be voided. If the invoice was created due to a + # top-up, the top-up will be disabled. # # @overload void(invoice_id, request_options: {}) # diff --git a/lib/orb/resources/items.rb b/lib/orb/resources/items.rb index b85cd708..ad64482a 100644 --- a/lib/orb/resources/items.rb +++ b/lib/orb/resources/items.rb @@ -42,7 +42,7 @@ def update(item_id, params = {}) end # This endpoint returns a list of all Items, ordered in descending order by - # creation time. + # creation time. # # @overload list(cursor: nil, limit: nil, request_options: {}) # diff --git a/lib/orb/resources/metrics.rb b/lib/orb/resources/metrics.rb index 47636cf7..3a58a27f 100644 --- a/lib/orb/resources/metrics.rb +++ b/lib/orb/resources/metrics.rb @@ -4,8 +4,8 @@ module Orb module Resources class Metrics # This endpoint is used to create a [metric](/core-concepts###metric) using a SQL - # string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a - # description of constructing SQL queries with examples. + # string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a + # description of constructing SQL queries with examples. # # @overload create(description:, item_id:, name:, sql:, metadata: nil, request_options: {}) # @@ -31,8 +31,8 @@ def create(params) end # This endpoint allows you to update the `metadata` property on a metric. If you - # pass `null` for the metadata value, it will clear any existing metadata for that - # invoice. + # pass `null` for the metadata value, it will clear any existing metadata for that + # invoice. # # @overload update(metric_id, metadata: nil, request_options: {}) # @@ -55,8 +55,8 @@ def update(metric_id, params = {}) end # This endpoint is used to fetch [metric](/core-concepts##metric) details given a - # metric identifier. It returns information about the metrics including its name, - # description, and item. + # metric identifier. It returns information about the metrics including its name, + # description, and item. # # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) # @@ -89,7 +89,7 @@ def list(params = {}) end # This endpoint is used to list [metrics](/core-concepts#metric). It returns - # information about the metrics including its name, description, and item. + # information about the metrics including its name, description, and item. # # @overload fetch(metric_id, request_options: {}) # diff --git a/lib/orb/resources/plans.rb b/lib/orb/resources/plans.rb index f8211743..e3d689d3 100644 --- a/lib/orb/resources/plans.rb +++ b/lib/orb/resources/plans.rb @@ -29,9 +29,9 @@ def create(params) end # This endpoint can be used to update the `external_plan_id`, and `metadata` of an - # existing plan. + # existing plan. # - # Other fields on a customer are currently immutable. + # Other fields on a customer are currently immutable. # # @overload update(plan_id, external_plan_id: nil, metadata: nil, request_options: {}) # @@ -55,10 +55,10 @@ def update(plan_id, params = {}) end # This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for - # an account in a list format. The list of plans is ordered starting from the most - # recently created plan. The response also includes - # [`pagination_metadata`](/api-reference/pagination), which lets the caller - # retrieve the next page of results if they exist. + # an account in a list format. The list of plans is ordered starting from the most + # recently created plan. The response also includes + # [`pagination_metadata`](/api-reference/pagination), which lets the caller + # retrieve the next page of results if they exist. # # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: nil, request_options: {}) # @@ -92,22 +92,22 @@ def list(params = {}) end # This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details - # given a plan identifier. It returns information about the prices included in the - # plan and their configuration, as well as the product that the plan is attached - # to. + # given a plan identifier. It returns information about the prices included in the + # plan and their configuration, as well as the product that the plan is attached + # to. # - # ## Serialized prices + # ## Serialized prices # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given [Price](/core-concepts#plan-and-price) - # object. The `model_type` field determines the key for the configuration object - # that is present. A detailed explanation of price types can be found in the - # [Price schema](/core-concepts#plan-and-price). + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given [Price](/core-concepts#plan-and-price) + # object. The `model_type` field determines the key for the configuration object + # that is present. A detailed explanation of price types can be found in the + # [Price schema](/core-concepts#plan-and-price). # - # ## Phases + # ## Phases # - # Orb supports plan phases, also known as contract ramps. For plans with phases, - # the serialized prices refer to all prices across all phases. + # Orb supports plan phases, also known as contract ramps. For plans with phases, + # the serialized prices refer to all prices across all phases. # # @overload fetch(plan_id, request_options: {}) # diff --git a/lib/orb/resources/plans/external_plan_id.rb b/lib/orb/resources/plans/external_plan_id.rb index 2fce5b4c..7302f3c5 100644 --- a/lib/orb/resources/plans/external_plan_id.rb +++ b/lib/orb/resources/plans/external_plan_id.rb @@ -5,9 +5,9 @@ module Resources class Plans class ExternalPlanID # This endpoint can be used to update the `external_plan_id`, and `metadata` of an - # existing plan. + # existing plan. # - # Other fields on a customer are currently immutable. + # Other fields on a customer are currently immutable. # # @overload update(other_external_plan_id, external_plan_id: nil, metadata: nil, request_options: {}) # @@ -31,21 +31,21 @@ def update(other_external_plan_id, params = {}) end # This endpoint is used to fetch [plan](/core-concepts##plan-and-price) details - # given an external_plan_id identifier. It returns information about the prices - # included in the plan and their configuration, as well as the product that the - # plan is attached to. + # given an external_plan_id identifier. It returns information about the prices + # included in the plan and their configuration, as well as the product that the + # plan is attached to. # - # If multiple plans are found to contain the specified external_plan_id, the - # active plans will take priority over archived ones, and among those, the - # endpoint will return the most recently created plan. + # If multiple plans are found to contain the specified external_plan_id, the + # active plans will take priority over archived ones, and among those, the + # endpoint will return the most recently created plan. # - # ## Serialized prices + # ## Serialized prices # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given [Price](/core-concepts#plan-and-price) - # object. The `model_type` field determines the key for the configuration object - # that is present. A detailed explanation of price types can be found in the - # [Price schema](/core-concepts#plan-and-price). " + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given [Price](/core-concepts#plan-and-price) + # object. The `model_type` field determines the key for the configuration object + # that is present. A detailed explanation of price types can be found in the + # [Price schema](/core-concepts#plan-and-price). " # # @overload fetch(external_plan_id, request_options: {}) # diff --git a/lib/orb/resources/prices.rb b/lib/orb/resources/prices.rb index 3b76c785..5730fb06 100644 --- a/lib/orb/resources/prices.rb +++ b/lib/orb/resources/prices.rb @@ -7,15 +7,15 @@ class Prices attr_reader :external_price_id # This endpoint is used to create a [price](/product-catalog/price-configuration). - # A price created using this endpoint is always an add-on, meaning that it’s not - # associated with a specific plan and can instead be individually added to - # subscriptions, including subscriptions on different plans. + # A price created using this endpoint is always an add-on, meaning that it’s not + # associated with a specific plan and can instead be individually added to + # subscriptions, including subscriptions on different plans. # - # An `external_price_id` can be optionally specified as an alias to allow - # ergonomic interaction with prices in the Orb API. + # An `external_price_id` can be optionally specified as an alias to allow + # ergonomic interaction with prices in the Orb API. # - # See the [Price resource](/product-catalog/price-configuration) for the - # specification of different price model configurations possible in this endpoint. + # See the [Price resource](/product-catalog/price-configuration) for the + # specification of different price model configurations possible in this endpoint. # # @overload create(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {}) # @@ -72,8 +72,8 @@ def create(params) end # This endpoint allows you to update the `metadata` property on a price. If you - # pass null for the metadata value, it will clear any existing metadata for that - # price. + # pass null for the metadata value, it will clear any existing metadata for that + # price. # # @overload update(price_id, metadata: nil, request_options: {}) # @@ -96,7 +96,7 @@ def update(price_id, params = {}) end # This endpoint is used to list all add-on prices created using the - # [price creation endpoint](/api-reference/price/create-price). + # [price creation endpoint](/api-reference/price/create-price). # # @overload list(cursor: nil, limit: nil, request_options: {}) # @@ -120,26 +120,26 @@ def list(params = {}) end # This endpoint is used to evaluate the output of a price for a given customer and - # time range. It enables filtering and grouping the output using - # [computed properties](/extensibility/advanced-metrics#computed-properties), - # supporting the following workflows: - # - # 1. Showing detailed usage and costs to the end customer. - # 2. Auditing subtotals on invoice line items. - # - # For these workflows, the expressiveness of computed properties in both the - # filters and grouping is critical. For example, if you'd like to show your - # customer their usage grouped by hour and another property, you can do so with - # the following `grouping_keys`: - # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd - # like to examine a customer's usage for a specific property value, you can do so - # with the following `filter`: - # `my_property = 'foo' AND my_other_property = 'bar'`. - # - # By default, the start of the time range must be no more than 100 days ago and - # the length of the results must be no greater than 1000. Note that this is a POST - # endpoint rather than a GET endpoint because it employs a JSON body rather than - # query parameters. + # time range. It enables filtering and grouping the output using + # [computed properties](/extensibility/advanced-metrics#computed-properties), + # supporting the following workflows: + # + # 1. Showing detailed usage and costs to the end customer. + # 2. Auditing subtotals on invoice line items. + # + # For these workflows, the expressiveness of computed properties in both the + # filters and grouping is critical. For example, if you'd like to show your + # customer their usage grouped by hour and another property, you can do so with + # the following `grouping_keys`: + # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd + # like to examine a customer's usage for a specific property value, you can do so + # with the following `filter`: + # `my_property = 'foo' AND my_other_property = 'bar'`. + # + # By default, the start of the time range must be no more than 100 days ago and + # the length of the results must be no greater than 1000. Note that this is a POST + # endpoint rather than a GET endpoint because it employs a JSON body rather than + # query parameters. # # @overload evaluate(price_id, timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, request_options: {}) # diff --git a/lib/orb/resources/prices/external_price_id.rb b/lib/orb/resources/prices/external_price_id.rb index 45838400..63e8644b 100644 --- a/lib/orb/resources/prices/external_price_id.rb +++ b/lib/orb/resources/prices/external_price_id.rb @@ -5,8 +5,8 @@ module Resources class Prices class ExternalPriceID # This endpoint allows you to update the `metadata` property on a price. If you - # pass null for the metadata value, it will clear any existing metadata for that - # price. + # pass null for the metadata value, it will clear any existing metadata for that + # price. # # @overload update(external_price_id, metadata: nil, request_options: {}) # @@ -29,8 +29,8 @@ def update(external_price_id, params = {}) end # This endpoint returns a price given an external price id. See the - # [price creation API](/api-reference/price/create-price) for more information - # about external price aliases. + # [price creation API](/api-reference/price/create-price) for more information + # about external price aliases. # # @overload fetch(external_price_id, request_options: {}) # diff --git a/lib/orb/resources/subscriptions.rb b/lib/orb/resources/subscriptions.rb index 59b214ed..b8683446 100644 --- a/lib/orb/resources/subscriptions.rb +++ b/lib/orb/resources/subscriptions.rb @@ -4,261 +4,261 @@ module Orb module Resources class Subscriptions # A subscription represents the purchase of a plan by a customer. The customer is - # identified by either the `customer_id` or the `external_customer_id`, and - # exactly one of these fields must be provided. - # - # By default, subscriptions begin on the day that they're created and renew - # automatically for each billing cycle at the cadence that's configured in the - # plan definition. - # - # The default configuration for subscriptions in Orb is **In-advance billing** and - # **Beginning of month alignment** (see - # [Subscription](/core-concepts##subscription) for more details). - # - # In order to change the alignment behavior, Orb also supports billing - # subscriptions on the day of the month they are created. If - # `align_billing_with_subscription_start_date = true` is specified, subscriptions - # have billing cycles that are aligned with their `start_date`. For example, a - # subscription that begins on January 15th will have a billing cycle from January - # 15th to February 15th. Every subsequent billing cycle will continue to start and - # invoice on the 15th. - # - # If the "day" value is greater than the number of days in the month, the next - # billing cycle will start at the end of the month. For example, if the start_date - # is January 31st, the next billing cycle will start on February 28th. - # - # If a customer was created with a currency, Orb only allows subscribing the - # customer to a plan with a matching `invoicing_currency`. If the customer does - # not have a currency set, on subscription creation, we set the customer's - # currency to be the `invoicing_currency` of the plan. - # - # ## Customize your customer's subscriptions - # - # Prices and adjustments in a plan can be added, removed, or replaced for the - # subscription being created. This is useful when a customer has prices that - # differ from the default prices for a specific plan. - # - # - # This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your - # Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans) - # - # - # ### Adding Prices - # - # To add prices, provide a list of objects with the key `add_prices`. An object in - # the list must specify an existing add-on price with a `price_id` or - # `external_price_id` field, or create a new add-on price by including an object - # with the key `price`, identical to what would be used in the request body for - # the [create price endpoint](/api-reference/price/create-price). See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations possible in this object. - # - # If the plan has phases, each object in the list must include a number with - # `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. - # - # An object in the list can specify an optional `minimum_amount`, - # `maximum_amount`, or `discounts`. This will create adjustments which apply only - # to this price. - # - # Additionally, an object in the list can specify an optional `reference_id`. This - # ID can be used to reference this price when - # [adding an adjustment](#adding-adjustments) in the same API call. However the ID - # is _transient_ and cannot be used to refer to the price in future API calls. - # - # ### Removing Prices - # - # To remove prices, provide a list of objects with the key `remove_prices`. An - # object in the list must specify a plan price with either a `price_id` or - # `external_price_id` field. - # - # ### Replacing Prices - # - # To replace prices, provide a list of objects with the key `replace_prices`. An - # object in the list must specify a plan price to replace with the - # `replaces_price_id` key, and it must specify a price to replace it with by - # either referencing an existing add-on price with a `price_id` or - # `external_price_id` field, or by creating a new add-on price by including an - # object with the key `price`, identical to what would be used in the request body - # for the [create price endpoint](/api-reference/price/create-price). See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations possible in this object. - # - # For fixed fees, an object in the list can supply a `fixed_price_quantity` - # instead of a `price`, `price_id`, or `external_price_id` field. This will update - # only the quantity for the price, similar to the - # [Update price quantity](/api-reference/subscription/update-price-quantity) - # endpoint. - # - # The replacement price will have the same phase, if applicable, and the same - # start and end dates as the price it replaces. - # - # An object in the list can specify an optional `minimum_amount`, - # `maximum_amount`, or `discounts`. This will create adjustments which apply only - # to this price. - # - # Additionally, an object in the list can specify an optional `reference_id`. This - # ID can be used to reference the replacement price when - # [adding an adjustment](#adding-adjustments) in the same API call. However the ID - # is _transient_ and cannot be used to refer to the price in future API calls. - # - # ### Adding adjustments - # - # To add adjustments, provide a list of objects with the key `add_adjustments`. An - # object in the list must include an object with the key `adjustment`, identical - # to the adjustment object in the - # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - # - # If the plan has phases, each object in the list must include a number with - # `plan_phase_order` key to indicate which phase the adjustment should be added - # 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. - # - # ### Removing adjustments - # - # To remove adjustments, provide a list of objects with the key - # `remove_adjustments`. An object in the list must include a key, `adjustment_id`, - # with the ID of the adjustment to be removed. - # - # ### Replacing adjustments - # - # To replace adjustments, provide a list of objects with the key - # `replace_adjustments`. An object in the list must specify a plan adjustment to - # replace with the `replaces_adjustment_id` key, and it must specify an adjustment - # to replace it with by including an object with the key `adjustment`, identical - # to the adjustment object in the - # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - # - # The replacement adjustment will have the same phase, if applicable, and the same - # start and end dates as the adjustment it replaces. - # - # ## Price overrides (DEPRECATED) - # - # - # Price overrides are being phased out in favor adding/removing/replacing prices. (See - # [Customize your customer's subscriptions](/api-reference/subscription/create-subscription)) - # - # - # Price overrides are used to update some or all prices in a plan for the specific - # subscription being created. This is useful when a new customer has negotiated a - # rate that is unique to the customer. - # - # To override prices, provide a list of objects with the key `price_overrides`. - # The price object in the list of overrides is expected to contain the existing - # price id, the `model_type` and configuration. (See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations.) The numerical values can be updated, but - # the billable metric, cadence, type, and name of a price can not be overridden. - # - # ### Maximums and Minimums - # - # Minimums and maximums, much like price overrides, can be useful when a new - # customer has negotiated a new or different minimum or maximum spend cap than the - # default for a given price. If one exists for a price and null is provided for - # the minimum/maximum override on creation, then there will be no minimum/maximum - # on the new subscription. If no value is provided, then the default price maximum - # or minimum is used. - # - # To add a minimum for a specific price, add `minimum_amount` to the specific - # price in the `price_overrides` object. - # - # To add a maximum for a specific price, add `maximum_amount` to the specific - # price in the `price_overrides` object. - # - # ### Minimum override example - # - # Price minimum override example: - # - # ```json - # { - # ... - # "id": "price_id", - # "model_type": "unit", - # "unit_config": { - # "unit_amount": "0.50" - # }, - # "minimum_amount": "100.00" - # ... - # } - # ``` - # - # Removing an existing minimum example - # - # ```json - # { - # ... - # "id": "price_id", - # "model_type": "unit", - # "unit_config": { - # "unit_amount": "0.50" - # }, - # "minimum_amount": null - # ... - # } - # ``` - # - # ### Discounts - # - # Discounts, like price overrides, can be useful when a new customer has - # negotiated a new or different discount than the default for a price. If a - # discount exists for a price and a null discount is provided on creation, then - # there will be no discount on the new subscription. - # - # To add a discount for a specific price, add `discount` to the price in the - # `price_overrides` object. Discount should be a dictionary of the format: - # - # ```ts - # { - # "discount_type": "amount" | "percentage" | "usage", - # "amount_discount": string, - # "percentage_discount": string, - # "usage_discount": string - # } - # ``` - # - # where either `amount_discount`, `percentage_discount`, or `usage_discount` is - # provided. - # - # Price discount example - # - # ```json - # { - # ... - # "id": "price_id", - # "model_type": "unit", - # "unit_config": { - # "unit_amount": "0.50" - # }, - # "discount": {"discount_type": "amount", "amount_discount": "175"}, - # } - # ``` - # - # Removing an existing discount example - # - # ```json - # { - # "customer_id": "customer_id", - # "plan_id": "plan_id", - # "discount": null, - # "price_overrides": [ ... ] - # ... - # } - # ``` - # - # ## Threshold Billing - # - # Orb supports invoicing for a subscription when a preconfigured usage threshold - # is hit. To enable threshold billing, pass in an `invoicing_threshold`, which is - # specified in the subscription's invoicing currency, when creating a - # subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit - # $10.00 for a subscription that invoices in USD. + # identified by either the `customer_id` or the `external_customer_id`, and + # exactly one of these fields must be provided. + # + # By default, subscriptions begin on the day that they're created and renew + # automatically for each billing cycle at the cadence that's configured in the + # plan definition. + # + # The default configuration for subscriptions in Orb is **In-advance billing** and + # **Beginning of month alignment** (see + # [Subscription](/core-concepts##subscription) for more details). + # + # In order to change the alignment behavior, Orb also supports billing + # subscriptions on the day of the month they are created. If + # `align_billing_with_subscription_start_date = true` is specified, subscriptions + # have billing cycles that are aligned with their `start_date`. For example, a + # subscription that begins on January 15th will have a billing cycle from January + # 15th to February 15th. Every subsequent billing cycle will continue to start and + # invoice on the 15th. + # + # If the "day" value is greater than the number of days in the month, the next + # billing cycle will start at the end of the month. For example, if the start_date + # is January 31st, the next billing cycle will start on February 28th. + # + # If a customer was created with a currency, Orb only allows subscribing the + # customer to a plan with a matching `invoicing_currency`. If the customer does + # not have a currency set, on subscription creation, we set the customer's + # currency to be the `invoicing_currency` of the plan. + # + # ## Customize your customer's subscriptions + # + # Prices and adjustments in a plan can be added, removed, or replaced for the + # subscription being created. This is useful when a customer has prices that + # differ from the default prices for a specific plan. + # + # + # This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your + # Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans) + # + # + # ### Adding Prices + # + # To add prices, provide a list of objects with the key `add_prices`. An object in + # the list must specify an existing add-on price with a `price_id` or + # `external_price_id` field, or create a new add-on price by including an object + # with the key `price`, identical to what would be used in the request body for + # the [create price endpoint](/api-reference/price/create-price). See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations possible in this object. + # + # If the plan has phases, each object in the list must include a number with + # `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. + # + # An object in the list can specify an optional `minimum_amount`, + # `maximum_amount`, or `discounts`. This will create adjustments which apply only + # to this price. + # + # Additionally, an object in the list can specify an optional `reference_id`. This + # ID can be used to reference this price when + # [adding an adjustment](#adding-adjustments) in the same API call. However the ID + # is _transient_ and cannot be used to refer to the price in future API calls. + # + # ### Removing Prices + # + # To remove prices, provide a list of objects with the key `remove_prices`. An + # object in the list must specify a plan price with either a `price_id` or + # `external_price_id` field. + # + # ### Replacing Prices + # + # To replace prices, provide a list of objects with the key `replace_prices`. An + # object in the list must specify a plan price to replace with the + # `replaces_price_id` key, and it must specify a price to replace it with by + # either referencing an existing add-on price with a `price_id` or + # `external_price_id` field, or by creating a new add-on price by including an + # object with the key `price`, identical to what would be used in the request body + # for the [create price endpoint](/api-reference/price/create-price). See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations possible in this object. + # + # For fixed fees, an object in the list can supply a `fixed_price_quantity` + # instead of a `price`, `price_id`, or `external_price_id` field. This will update + # only the quantity for the price, similar to the + # [Update price quantity](/api-reference/subscription/update-price-quantity) + # endpoint. + # + # The replacement price will have the same phase, if applicable, and the same + # start and end dates as the price it replaces. + # + # An object in the list can specify an optional `minimum_amount`, + # `maximum_amount`, or `discounts`. This will create adjustments which apply only + # to this price. + # + # Additionally, an object in the list can specify an optional `reference_id`. This + # ID can be used to reference the replacement price when + # [adding an adjustment](#adding-adjustments) in the same API call. However the ID + # is _transient_ and cannot be used to refer to the price in future API calls. + # + # ### Adding adjustments + # + # To add adjustments, provide a list of objects with the key `add_adjustments`. An + # object in the list must include an object with the key `adjustment`, identical + # to the adjustment object in the + # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). + # + # If the plan has phases, each object in the list must include a number with + # `plan_phase_order` key to indicate which phase the adjustment should be added + # 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. + # + # ### Removing adjustments + # + # To remove adjustments, provide a list of objects with the key + # `remove_adjustments`. An object in the list must include a key, `adjustment_id`, + # with the ID of the adjustment to be removed. + # + # ### Replacing adjustments + # + # To replace adjustments, provide a list of objects with the key + # `replace_adjustments`. An object in the list must specify a plan adjustment to + # replace with the `replaces_adjustment_id` key, and it must specify an adjustment + # to replace it with by including an object with the key `adjustment`, identical + # to the adjustment object in the + # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). + # + # The replacement adjustment will have the same phase, if applicable, and the same + # start and end dates as the adjustment it replaces. + # + # ## Price overrides (DEPRECATED) + # + # + # Price overrides are being phased out in favor adding/removing/replacing prices. (See + # [Customize your customer's subscriptions](/api-reference/subscription/create-subscription)) + # + # + # Price overrides are used to update some or all prices in a plan for the specific + # subscription being created. This is useful when a new customer has negotiated a + # rate that is unique to the customer. + # + # To override prices, provide a list of objects with the key `price_overrides`. + # The price object in the list of overrides is expected to contain the existing + # price id, the `model_type` and configuration. (See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations.) The numerical values can be updated, but + # the billable metric, cadence, type, and name of a price can not be overridden. + # + # ### Maximums and Minimums + # + # Minimums and maximums, much like price overrides, can be useful when a new + # customer has negotiated a new or different minimum or maximum spend cap than the + # default for a given price. If one exists for a price and null is provided for + # the minimum/maximum override on creation, then there will be no minimum/maximum + # on the new subscription. If no value is provided, then the default price maximum + # or minimum is used. + # + # To add a minimum for a specific price, add `minimum_amount` to the specific + # price in the `price_overrides` object. + # + # To add a maximum for a specific price, add `maximum_amount` to the specific + # price in the `price_overrides` object. + # + # ### Minimum override example + # + # Price minimum override example: + # + # ```json + # { + # ... + # "id": "price_id", + # "model_type": "unit", + # "unit_config": { + # "unit_amount": "0.50" + # }, + # "minimum_amount": "100.00" + # ... + # } + # ``` + # + # Removing an existing minimum example + # + # ```json + # { + # ... + # "id": "price_id", + # "model_type": "unit", + # "unit_config": { + # "unit_amount": "0.50" + # }, + # "minimum_amount": null + # ... + # } + # ``` + # + # ### Discounts + # + # Discounts, like price overrides, can be useful when a new customer has + # negotiated a new or different discount than the default for a price. If a + # discount exists for a price and a null discount is provided on creation, then + # there will be no discount on the new subscription. + # + # To add a discount for a specific price, add `discount` to the price in the + # `price_overrides` object. Discount should be a dictionary of the format: + # + # ```ts + # { + # "discount_type": "amount" | "percentage" | "usage", + # "amount_discount": string, + # "percentage_discount": string, + # "usage_discount": string + # } + # ``` + # + # where either `amount_discount`, `percentage_discount`, or `usage_discount` is + # provided. + # + # Price discount example + # + # ```json + # { + # ... + # "id": "price_id", + # "model_type": "unit", + # "unit_config": { + # "unit_amount": "0.50" + # }, + # "discount": {"discount_type": "amount", "amount_discount": "175"}, + # } + # ``` + # + # Removing an existing discount example + # + # ```json + # { + # "customer_id": "customer_id", + # "plan_id": "plan_id", + # "discount": null, + # "price_overrides": [ ... ] + # ... + # } + # ``` + # + # ## Threshold Billing + # + # Orb supports invoicing for a subscription when a preconfigured usage threshold + # is hit. To enable threshold billing, pass in an `invoicing_threshold`, which is + # specified in the subscription's invoicing currency, when creating a + # subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit + # $10.00 for a subscription that invoices in USD. # # @overload create(add_adjustments: nil, add_prices: nil, align_billing_with_subscription_start_date: nil, auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, coupon_redemption_code: nil, credits_overage_rate: nil, customer_id: nil, default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, start_date: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {}) # @@ -310,8 +310,8 @@ def create(params = {}) end # This endpoint can be used to update the `metadata`, `net terms`, - # `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties - # on a subscription. + # `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties + # on a subscription. # # @overload update(subscription_id, auto_collection: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {}) # @@ -338,14 +338,14 @@ def update(subscription_id, params = {}) end # This endpoint returns a list of all subscriptions for an account as a - # [paginated](/api-reference/pagination) list, ordered starting from the most - # recently created subscription. For a full discussion of the subscription - # resource, see [Subscription](/core-concepts##subscription). + # [paginated](/api-reference/pagination) list, ordered starting from the most + # recently created subscription. For a full discussion of the subscription + # resource, see [Subscription](/core-concepts##subscription). # - # Subscriptions can be filtered for a specific customer by using either the - # customer_id or external_customer_id query parameters. To filter subscriptions - # for multiple customers, use the customer_id[] or external_customer_id[] query - # parameters. + # Subscriptions can be filtered for a specific customer by using either the + # customer_id or external_customer_id query parameters. To filter subscriptions + # for multiple customers, use the customer_id[] or external_customer_id[] query + # parameters. # # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, status: nil, request_options: {}) # @@ -381,66 +381,66 @@ def list(params = {}) end # This endpoint can be used to cancel an existing subscription. It returns the - # serialized subscription object with an `end_date` parameter that signifies when - # the subscription will transition to an ended state. - # - # The body parameter `cancel_option` determines the cancellation behavior. Orb - # supports three cancellation options: - # - # - `end_of_subscription_term`: stops the subscription from auto-renewing. - # Subscriptions that have been cancelled with this option can still incur - # charges for the remainder of their term: - # - # - Issuing this cancellation request for a monthly subscription will keep the - # subscription active until the start of the subsequent month, and potentially - # issue an invoice for any usage charges incurred in the intervening period. - # - Issuing this cancellation request for a quarterly subscription will keep the - # subscription active until the end of the quarter and potentially issue an - # invoice for any usage charges incurred in the intervening period. - # - Issuing this cancellation request for a yearly subscription will keep the - # subscription active for the full year. For example, a yearly subscription - # starting on 2021-11-01 and cancelled on 2021-12-08 will remain active until - # 2022-11-01 and potentially issue charges in the intervening months for any - # recurring monthly usage charges in its plan. - # - **Note**: If a subscription's plan contains prices with difference cadences, - # the end of term date will be determined by the largest cadence value. For - # example, cancelling end of term for a subscription with a quarterly fixed - # fee with a monthly usage fee will result in the subscription ending at the - # end of the quarter. - # - # - `immediate`: ends the subscription immediately, setting the `end_date` to the - # current time: - # - # - Subscriptions that have been cancelled with this option will be invoiced - # immediately. This invoice will include any usage fees incurred in the - # billing period up to the cancellation, along with any prorated recurring - # fees for the billing period, if applicable. - # - **Note**: If the subscription has a recurring fee that was paid in-advance, - # the prorated amount for the remaining time period will be added to the - # [customer's balance](list-balance-transactions) upon immediate cancellation. - # However, if the customer is ineligible to use the customer balance, the - # subscription cannot be cancelled immediately. - # - # - `requested_date`: ends the subscription on a specified date, which requires a - # `cancellation_date` to be passed in. If no timezone is provided, the - # customer's timezone is used. For example, a subscription starting on January - # 1st with a monthly price can be set to be cancelled on the first of any month - # after January 1st (e.g. March 1st, April 1st, May 1st). A subscription with - # multiple prices with different cadences defines the "term" to be the highest - # cadence of the prices. - # - # Upcoming subscriptions are only eligible for immediate cancellation, which will - # set the `end_date` equal to the `start_date` upon cancellation. - # - # ## Backdated cancellations - # - # Orb allows you to cancel a subscription in the past as long as there are no paid - # invoices between the `requested_date` and the current time. If the cancellation - # is after the latest issued invoice, Orb will generate a balance refund for the - # current period. If the cancellation is before the most recently issued invoice, - # Orb will void the intervening invoice and generate a new one based on the new - # dates for the subscription. See the section on - # [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors). + # serialized subscription object with an `end_date` parameter that signifies when + # the subscription will transition to an ended state. + # + # The body parameter `cancel_option` determines the cancellation behavior. Orb + # supports three cancellation options: + # + # - `end_of_subscription_term`: stops the subscription from auto-renewing. + # Subscriptions that have been cancelled with this option can still incur + # charges for the remainder of their term: + # + # - Issuing this cancellation request for a monthly subscription will keep the + # subscription active until the start of the subsequent month, and potentially + # issue an invoice for any usage charges incurred in the intervening period. + # - Issuing this cancellation request for a quarterly subscription will keep the + # subscription active until the end of the quarter and potentially issue an + # invoice for any usage charges incurred in the intervening period. + # - Issuing this cancellation request for a yearly subscription will keep the + # subscription active for the full year. For example, a yearly subscription + # starting on 2021-11-01 and cancelled on 2021-12-08 will remain active until + # 2022-11-01 and potentially issue charges in the intervening months for any + # recurring monthly usage charges in its plan. + # - **Note**: If a subscription's plan contains prices with difference cadences, + # the end of term date will be determined by the largest cadence value. For + # example, cancelling end of term for a subscription with a quarterly fixed + # fee with a monthly usage fee will result in the subscription ending at the + # end of the quarter. + # + # - `immediate`: ends the subscription immediately, setting the `end_date` to the + # current time: + # + # - Subscriptions that have been cancelled with this option will be invoiced + # immediately. This invoice will include any usage fees incurred in the + # billing period up to the cancellation, along with any prorated recurring + # fees for the billing period, if applicable. + # - **Note**: If the subscription has a recurring fee that was paid in-advance, + # the prorated amount for the remaining time period will be added to the + # [customer's balance](list-balance-transactions) upon immediate cancellation. + # However, if the customer is ineligible to use the customer balance, the + # subscription cannot be cancelled immediately. + # + # - `requested_date`: ends the subscription on a specified date, which requires a + # `cancellation_date` to be passed in. If no timezone is provided, the + # customer's timezone is used. For example, a subscription starting on January + # 1st with a monthly price can be set to be cancelled on the first of any month + # after January 1st (e.g. March 1st, April 1st, May 1st). A subscription with + # multiple prices with different cadences defines the "term" to be the highest + # cadence of the prices. + # + # Upcoming subscriptions are only eligible for immediate cancellation, which will + # set the `end_date` equal to the `start_date` upon cancellation. + # + # ## Backdated cancellations + # + # Orb allows you to cancel a subscription in the past as long as there are no paid + # invoices between the `requested_date` and the current time. If the cancellation + # is after the latest issued invoice, Orb will generate a balance refund for the + # current period. If the cancellation is before the most recently issued invoice, + # Orb will void the intervening invoice and generate a new one based on the new + # dates for the subscription. See the section on + # [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors). # # @overload cancel(subscription_id, cancel_option:, allow_invoice_credit_or_void: nil, cancellation_date: nil, request_options: {}) # @@ -465,7 +465,7 @@ def cancel(subscription_id, params) end # This endpoint is used to fetch a [Subscription](/core-concepts##subscription) - # given an identifier. + # given an identifier. # # @overload fetch(subscription_id, request_options: {}) # @@ -485,15 +485,15 @@ def fetch(subscription_id, params = {}) end # This endpoint is used to fetch a day-by-day snapshot of a subscription's costs - # in Orb, calculated by applying pricing information to the underlying usage (see - # the [subscription usage endpoint](fetch-subscription-usage) to fetch usage per - # metric, in usage units rather than a currency). + # in Orb, calculated by applying pricing information to the underlying usage (see + # the [subscription usage endpoint](fetch-subscription-usage) to fetch usage per + # metric, in usage units rather than a currency). # - # The semantics of this endpoint exactly mirror those of - # [fetching a customer's costs](fetch-customer-costs). Use this endpoint to limit - # your analysis of costs to a specific subscription for the customer (e.g. to - # de-aggregate costs when a customer's subscription has started and stopped on the - # same day). + # The semantics of this endpoint exactly mirror those of + # [fetching a customer's costs](fetch-customer-costs). Use this endpoint to limit + # your analysis of costs to a specific subscription for the customer (e.g. to + # de-aggregate costs when a customer's subscription has started and stopped on the + # same day). # # @overload fetch_costs(subscription_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # @@ -519,9 +519,9 @@ def fetch_costs(subscription_id, params = {}) end # This endpoint returns a [paginated](/api-reference/pagination) list of all plans - # associated with a subscription along with their start and end dates. This list - # contains the subscription's initial plan along with past and future plan - # changes. + # associated with a subscription along with their start and end dates. This list + # contains the subscription's initial plan along with past and future plan + # changes. # # @overload fetch_schedule(subscription_id, cursor: nil, limit: nil, start_date_gt: nil, start_date_gte: nil, start_date_lt: nil, start_date_lte: nil, request_options: {}) # @@ -555,199 +555,199 @@ def fetch_schedule(subscription_id, params = {}) end # This endpoint is used to fetch a subscription's usage in Orb. Especially when - # combined with optional query parameters, this endpoint is a powerful way to - # build visualizations on top of Orb's event data and metrics. - # - # With no query parameters specified, this endpoint returns usage for the - # subscription's _current billing period_ across each billable metric that - # participates in the subscription. Usage quantities returned are the result of - # evaluating the metric definition for the entirety of the customer's billing - # period. - # - # ### Default response shape - # - # Orb returns a `data` array with an object corresponding to each billable metric. - # Nested within this object is a `usage` array which has a `quantity` value and a - # corresponding `timeframe_start` and `timeframe_end`. The `quantity` value - # represents the calculated usage value for the billable metric over the specified - # timeframe (inclusive of the `timeframe_start` timestamp and exclusive of the - # `timeframe_end` timestamp). - # - # Orb will include _every_ window in the response starting from the beginning of - # the billing period, even when there were no events (and therefore no usage) in - # the window. This increases the size of the response but prevents the caller from - # filling in gaps and handling cumbersome time-based logic. - # - # The query parameters in this endpoint serve to override this behavior and - # provide some key functionality, as listed below. Note that this functionality - # can also be used _in conjunction_ with each other, e.g. to display grouped usage - # on a custom timeframe. - # - # ## Custom timeframe - # - # In order to view usage for a custom timeframe rather than the current billing - # period, specify a `timeframe_start` and `timeframe_end`. This will calculate - # quantities for usage incurred between timeframe_start (inclusive) and - # timeframe_end (exclusive), i.e. `[timeframe_start, timeframe_end)`. - # - # Note: - # - # - These timestamps must be specified in ISO 8601 format and UTC timezone, e.g. - # `2022-02-01T05:00:00Z`. - # - Both parameters must be specified if either is specified. - # - # ## Grouping by custom attributes - # - # In order to view a single metric grouped by a specific _attribute_ that each - # event is tagged with (e.g. `cluster`), you must additionally specify a - # `billable_metric_id` and a `group_by` key. The `group_by` key denotes the event - # property on which to group. - # - # When returning grouped usage, only usage for `billable_metric_id` is returned, - # and a separate object in the `data` array is returned for each value of the - # `group_by` key present in your events. The `quantity` value is the result of - # evaluating the billable metric for events filtered to a single value of the - # `group_by` key. - # - # Orb expects that events that match the billable metric will contain values in - # the `properties` dictionary that correspond to the `group_by` key specified. By - # default, Orb will not return a `null` group (i.e. events that match the metric - # but do not have the key set). Currently, it is only possible to view usage - # grouped by a single attribute at a time. - # - # When viewing grouped usage, Orb uses pagination to limit the response size to - # 1000 groups by default. If there are more groups for a given subscription, - # pagination metadata in the response can be used to fetch all of the data. - # - # The following example shows usage for an "API Requests" billable metric grouped - # by `region`. Note the extra `metric_group` dictionary in the response, which - # provides metadata about the group: - # - # ```json - # { - # "data": [ - # { - # "usage": [ - # { - # "quantity": 0.19291, - # "timeframe_start": "2021-10-01T07:00:00Z", - # "timeframe_end": "2021-10-02T07:00:00Z", - # }, - # ... - # ], - # "metric_group": { - # "property_key": "region", - # "property_value": "asia/pacific" - # }, - # "billable_metric": { - # "id": "Fe9pbpMk86xpwdGB", - # "name": "API Requests" - # }, - # "view_mode": "periodic" - # }, - # ... - # ] - # } - # ``` - # - # ## Windowed usage - # - # The `granularity` parameter can be used to _window_ the usage `quantity` value - # into periods. When not specified, usage is returned for the entirety of the time - # range. - # - # When `granularity = day` is specified with a timeframe longer than a day, Orb - # will return a `quantity` value for each full day between `timeframe_start` and - # `timeframe_end`. Note that the days are demarcated by the _customer's local - # midnight_. - # - # For example, with `timeframe_start = 2022-02-01T05:00:00Z`, - # `timeframe_end = 2022-02-04T01:00:00Z` and `granularity=day`, the following - # windows will be returned for a customer in the `America/Los_Angeles` timezone - # since local midnight is `08:00` UTC: - # - # - `[2022-02-01T05:00:00Z, 2022-02-01T08:00:00Z)` - # - `[2022-02-01T08:00:00, 2022-02-02T08:00:00Z)` - # - `[2022-02-02T08:00:00, 2022-02-03T08:00:00Z)` - # - `[2022-02-03T08:00:00, 2022-02-04T01:00:00Z)` - # - # ```json - # { - # "data": [ - # { - # "billable_metric": { - # "id": "Q8w89wjTtBdejXKsm", - # "name": "API Requests" - # }, - # "usage": [ - # { - # "quantity": 0, - # "timeframe_end": "2022-02-01T08:00:00+00:00", - # "timeframe_start": "2022-02-01T05:00:00+00:00" - # }, - # { - # - # "quantity": 0, - # "timeframe_end": "2022-02-02T08:00:00+00:00", - # "timeframe_start": "2022-02-01T08:00:00+00:00" - # }, - # { - # "quantity": 0, - # "timeframe_end": "2022-02-03T08:00:00+00:00", - # "timeframe_start": "2022-02-02T08:00:00+00:00" - # }, - # { - # "quantity": 0, - # "timeframe_end": "2022-02-04T01:00:00+00:00", - # "timeframe_start": "2022-02-03T08:00:00+00:00" - # } - # ], - # "view_mode": "periodic" - # }, - # ... - # ] - # } - # ``` - # - # ## Decomposable vs. non-decomposable metrics - # - # Billable metrics fall into one of two categories: decomposable and - # non-decomposable. A decomposable billable metric, such as a sum or a count, can - # be displayed and aggregated across arbitrary timescales. On the other hand, a - # non-decomposable metric is not meaningful when only a slice of the billing - # window is considered. - # - # As an example, if we have a billable metric that's defined to count unique - # users, displaying a graph of unique users for each day is not representative of - # the billable metric value over the month (days could have an overlapping set of - # 'unique' users). Instead, what's useful for any given day is the number of - # unique users in the billing period so far, which are the _cumulative_ unique - # users. - # - # Accordingly, this endpoint returns treats these two types of metrics differently - # when `group_by` is specified: - # - # - Decomposable metrics can be grouped by any event property. - # - Non-decomposable metrics can only be grouped by the corresponding price's - # invoice grouping key. If no invoice grouping key is present, the metric does - # not support `group_by`. - # - # ## Matrix prices - # - # When a billable metric is attached to a price that uses matrix pricing, it's - # important to view usage grouped by those matrix dimensions. In this case, use - # the query parameters `first_dimension_key`, `first_dimension_value` and - # `second_dimension_key`, `second_dimension_value` while filtering to a specific - # `billable_metric_id`. - # - # For example, if your compute metric has a separate unit price (i.e. a matrix - # pricing model) per `region` and `provider`, your request might provide the - # following parameters: - # - # - `first_dimension_key`: `region` - # - `first_dimension_value`: `us-east-1` - # - `second_dimension_key`: `provider` - # - `second_dimension_value`: `aws` + # combined with optional query parameters, this endpoint is a powerful way to + # build visualizations on top of Orb's event data and metrics. + # + # With no query parameters specified, this endpoint returns usage for the + # subscription's _current billing period_ across each billable metric that + # participates in the subscription. Usage quantities returned are the result of + # evaluating the metric definition for the entirety of the customer's billing + # period. + # + # ### Default response shape + # + # Orb returns a `data` array with an object corresponding to each billable metric. + # Nested within this object is a `usage` array which has a `quantity` value and a + # corresponding `timeframe_start` and `timeframe_end`. The `quantity` value + # represents the calculated usage value for the billable metric over the specified + # timeframe (inclusive of the `timeframe_start` timestamp and exclusive of the + # `timeframe_end` timestamp). + # + # Orb will include _every_ window in the response starting from the beginning of + # the billing period, even when there were no events (and therefore no usage) in + # the window. This increases the size of the response but prevents the caller from + # filling in gaps and handling cumbersome time-based logic. + # + # The query parameters in this endpoint serve to override this behavior and + # provide some key functionality, as listed below. Note that this functionality + # can also be used _in conjunction_ with each other, e.g. to display grouped usage + # on a custom timeframe. + # + # ## Custom timeframe + # + # In order to view usage for a custom timeframe rather than the current billing + # period, specify a `timeframe_start` and `timeframe_end`. This will calculate + # quantities for usage incurred between timeframe_start (inclusive) and + # timeframe_end (exclusive), i.e. `[timeframe_start, timeframe_end)`. + # + # Note: + # + # - These timestamps must be specified in ISO 8601 format and UTC timezone, e.g. + # `2022-02-01T05:00:00Z`. + # - Both parameters must be specified if either is specified. + # + # ## Grouping by custom attributes + # + # In order to view a single metric grouped by a specific _attribute_ that each + # event is tagged with (e.g. `cluster`), you must additionally specify a + # `billable_metric_id` and a `group_by` key. The `group_by` key denotes the event + # property on which to group. + # + # When returning grouped usage, only usage for `billable_metric_id` is returned, + # and a separate object in the `data` array is returned for each value of the + # `group_by` key present in your events. The `quantity` value is the result of + # evaluating the billable metric for events filtered to a single value of the + # `group_by` key. + # + # Orb expects that events that match the billable metric will contain values in + # the `properties` dictionary that correspond to the `group_by` key specified. By + # default, Orb will not return a `null` group (i.e. events that match the metric + # but do not have the key set). Currently, it is only possible to view usage + # grouped by a single attribute at a time. + # + # When viewing grouped usage, Orb uses pagination to limit the response size to + # 1000 groups by default. If there are more groups for a given subscription, + # pagination metadata in the response can be used to fetch all of the data. + # + # The following example shows usage for an "API Requests" billable metric grouped + # by `region`. Note the extra `metric_group` dictionary in the response, which + # provides metadata about the group: + # + # ```json + # { + # "data": [ + # { + # "usage": [ + # { + # "quantity": 0.19291, + # "timeframe_start": "2021-10-01T07:00:00Z", + # "timeframe_end": "2021-10-02T07:00:00Z", + # }, + # ... + # ], + # "metric_group": { + # "property_key": "region", + # "property_value": "asia/pacific" + # }, + # "billable_metric": { + # "id": "Fe9pbpMk86xpwdGB", + # "name": "API Requests" + # }, + # "view_mode": "periodic" + # }, + # ... + # ] + # } + # ``` + # + # ## Windowed usage + # + # The `granularity` parameter can be used to _window_ the usage `quantity` value + # into periods. When not specified, usage is returned for the entirety of the time + # range. + # + # When `granularity = day` is specified with a timeframe longer than a day, Orb + # will return a `quantity` value for each full day between `timeframe_start` and + # `timeframe_end`. Note that the days are demarcated by the _customer's local + # midnight_. + # + # For example, with `timeframe_start = 2022-02-01T05:00:00Z`, + # `timeframe_end = 2022-02-04T01:00:00Z` and `granularity=day`, the following + # windows will be returned for a customer in the `America/Los_Angeles` timezone + # since local midnight is `08:00` UTC: + # + # - `[2022-02-01T05:00:00Z, 2022-02-01T08:00:00Z)` + # - `[2022-02-01T08:00:00, 2022-02-02T08:00:00Z)` + # - `[2022-02-02T08:00:00, 2022-02-03T08:00:00Z)` + # - `[2022-02-03T08:00:00, 2022-02-04T01:00:00Z)` + # + # ```json + # { + # "data": [ + # { + # "billable_metric": { + # "id": "Q8w89wjTtBdejXKsm", + # "name": "API Requests" + # }, + # "usage": [ + # { + # "quantity": 0, + # "timeframe_end": "2022-02-01T08:00:00+00:00", + # "timeframe_start": "2022-02-01T05:00:00+00:00" + # }, + # { + # + # "quantity": 0, + # "timeframe_end": "2022-02-02T08:00:00+00:00", + # "timeframe_start": "2022-02-01T08:00:00+00:00" + # }, + # { + # "quantity": 0, + # "timeframe_end": "2022-02-03T08:00:00+00:00", + # "timeframe_start": "2022-02-02T08:00:00+00:00" + # }, + # { + # "quantity": 0, + # "timeframe_end": "2022-02-04T01:00:00+00:00", + # "timeframe_start": "2022-02-03T08:00:00+00:00" + # } + # ], + # "view_mode": "periodic" + # }, + # ... + # ] + # } + # ``` + # + # ## Decomposable vs. non-decomposable metrics + # + # Billable metrics fall into one of two categories: decomposable and + # non-decomposable. A decomposable billable metric, such as a sum or a count, can + # be displayed and aggregated across arbitrary timescales. On the other hand, a + # non-decomposable metric is not meaningful when only a slice of the billing + # window is considered. + # + # As an example, if we have a billable metric that's defined to count unique + # users, displaying a graph of unique users for each day is not representative of + # the billable metric value over the month (days could have an overlapping set of + # 'unique' users). Instead, what's useful for any given day is the number of + # unique users in the billing period so far, which are the _cumulative_ unique + # users. + # + # Accordingly, this endpoint returns treats these two types of metrics differently + # when `group_by` is specified: + # + # - Decomposable metrics can be grouped by any event property. + # - Non-decomposable metrics can only be grouped by the corresponding price's + # invoice grouping key. If no invoice grouping key is present, the metric does + # not support `group_by`. + # + # ## Matrix prices + # + # When a billable metric is attached to a price that uses matrix pricing, it's + # important to view usage grouped by those matrix dimensions. In this case, use + # the query parameters `first_dimension_key`, `first_dimension_value` and + # `second_dimension_key`, `second_dimension_value` while filtering to a specific + # `billable_metric_id`. + # + # For example, if your compute metric has a separate unit price (i.e. a matrix + # pricing model) per `region` and `provider`, your request might provide the + # following parameters: + # + # - `first_dimension_key`: `region` + # - `first_dimension_value`: `us-east-1` + # - `second_dimension_key`: `provider` + # - `second_dimension_value`: `aws` # # @overload fetch_usage(subscription_id, billable_metric_id: nil, first_dimension_key: nil, first_dimension_value: nil, granularity: nil, group_by: nil, second_dimension_key: nil, second_dimension_value: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # @@ -779,77 +779,77 @@ def fetch_usage(subscription_id, params = {}) end # This endpoint is used to add and edit subscription - # [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By - # making modifications to a subscription’s price intervals, you can - # [flexibly and atomically control the billing behavior of a subscription](/product-catalog/modifying-subscriptions). - # - # ## Adding price intervals - # - # Prices can be added as price intervals to a subscription by specifying them in - # the `add` array. A `price_id` or `external_price_id` from an add-on price or - # previously removed plan price can be specified to reuse an existing price - # definition (however, please note that prices from other plans cannot be added to - # the subscription). Additionally, a new price can be specified using the `price` - # field — this price will be created automatically. - # - # A `start_date` must be specified for the price interval. This is the date when - # the price will start billing on the subscription, so this will notably result in - # an immediate charge at this time for any billed in advance fixed fees. The - # `end_date` will default to null, resulting in a price interval that will bill on - # a continually recurring basis. Both of these dates can be set in the past or the - # future and Orb will generate or modify invoices to ensure the subscription’s - # invoicing behavior is correct. - # - # Additionally, a discount, minimum, or maximum can be specified on the price - # interval. This will only apply to this price interval, not any other price - # intervals on the subscription. - # - # ## Adjustment intervals - # - # An adjustment interval represents the time period that a particular adjustment - # (a discount, minimum, or maximum) applies to the prices on a subscription. - # Adjustment intervals can be added to a subscription by specifying them in the - # `add_adjustments` array, or modified via the `edit_adjustments` array. When - # creating an adjustment interval, you'll need to provide the definition of the - # new adjustment (the type of adjustment, and which prices it applies to), as well - # as the start and end dates for the adjustment interval. The start and end dates - # of an existing adjustment interval can be edited via the `edit_adjustments` - # field (just like price intervals). (To "change" the amount of a discount, - # minimum, or maximum, then, you'll need to end the existing interval, and create - # a new adjustment interval with the new amount and a start date that matches the - # end date of the previous interval.) - # - # ## Editing price intervals - # - # Price intervals can be adjusted by specifying edits to make in the `edit` array. - # A `price_interval_id` to edit must be specified — this can be retrieved from the - # `price_intervals` field on the subscription. - # - # A new `start_date` or `end_date` can be specified to change the range of the - # price interval, which will modify past or future invoices to ensure correctness. - # If either of these dates are unspecified, they will default to the existing date - # on the price interval. To remove a price interval entirely from a subscription, - # set the `end_date` to be equivalent to the `start_date`. - # - # ## Fixed fee quantity transitions - # - # The fixed fee quantity transitions for a fixed fee price interval can also be - # specified when adding or editing by passing an array for - # `fixed_fee_quantity_transitions`. A fixed fee quantity transition must have a - # `quantity` and an `effective_date`, which is the date after which the new - # quantity will be used for billing. If a fixed fee quantity transition is - # scheduled at a billing period boundary, the full quantity will be billed on an - # invoice with the other prices on the subscription. If the fixed fee quantity - # transition is scheduled mid-billing period, the difference between the existing - # quantity and quantity specified in the transition will be prorated for the rest - # of the billing period and billed immediately, which will generate a new invoice. - # - # Notably, the list of fixed fee quantity transitions passed will overwrite the - # existing fixed fee quantity transitions on the price interval, so the entire - # list of transitions must be specified to add additional transitions. The - # existing list of transitions can be retrieved using the - # `fixed_fee_quantity_transitions` property on a subscription’s serialized price - # intervals. + # [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By + # making modifications to a subscription’s price intervals, you can + # [flexibly and atomically control the billing behavior of a subscription](/product-catalog/modifying-subscriptions). + # + # ## Adding price intervals + # + # Prices can be added as price intervals to a subscription by specifying them in + # the `add` array. A `price_id` or `external_price_id` from an add-on price or + # previously removed plan price can be specified to reuse an existing price + # definition (however, please note that prices from other plans cannot be added to + # the subscription). Additionally, a new price can be specified using the `price` + # field — this price will be created automatically. + # + # A `start_date` must be specified for the price interval. This is the date when + # the price will start billing on the subscription, so this will notably result in + # an immediate charge at this time for any billed in advance fixed fees. The + # `end_date` will default to null, resulting in a price interval that will bill on + # a continually recurring basis. Both of these dates can be set in the past or the + # future and Orb will generate or modify invoices to ensure the subscription’s + # invoicing behavior is correct. + # + # Additionally, a discount, minimum, or maximum can be specified on the price + # interval. This will only apply to this price interval, not any other price + # intervals on the subscription. + # + # ## Adjustment intervals + # + # An adjustment interval represents the time period that a particular adjustment + # (a discount, minimum, or maximum) applies to the prices on a subscription. + # Adjustment intervals can be added to a subscription by specifying them in the + # `add_adjustments` array, or modified via the `edit_adjustments` array. When + # creating an adjustment interval, you'll need to provide the definition of the + # new adjustment (the type of adjustment, and which prices it applies to), as well + # as the start and end dates for the adjustment interval. The start and end dates + # of an existing adjustment interval can be edited via the `edit_adjustments` + # field (just like price intervals). (To "change" the amount of a discount, + # minimum, or maximum, then, you'll need to end the existing interval, and create + # a new adjustment interval with the new amount and a start date that matches the + # end date of the previous interval.) + # + # ## Editing price intervals + # + # Price intervals can be adjusted by specifying edits to make in the `edit` array. + # A `price_interval_id` to edit must be specified — this can be retrieved from the + # `price_intervals` field on the subscription. + # + # A new `start_date` or `end_date` can be specified to change the range of the + # price interval, which will modify past or future invoices to ensure correctness. + # If either of these dates are unspecified, they will default to the existing date + # on the price interval. To remove a price interval entirely from a subscription, + # set the `end_date` to be equivalent to the `start_date`. + # + # ## Fixed fee quantity transitions + # + # The fixed fee quantity transitions for a fixed fee price interval can also be + # specified when adding or editing by passing an array for + # `fixed_fee_quantity_transitions`. A fixed fee quantity transition must have a + # `quantity` and an `effective_date`, which is the date after which the new + # quantity will be used for billing. If a fixed fee quantity transition is + # scheduled at a billing period boundary, the full quantity will be billed on an + # invoice with the other prices on the subscription. If the fixed fee quantity + # transition is scheduled mid-billing period, the difference between the existing + # quantity and quantity specified in the transition will be prorated for the rest + # of the billing period and billed immediately, which will generate a new invoice. + # + # Notably, the list of fixed fee quantity transitions passed will overwrite the + # existing fixed fee quantity transitions on the price interval, so the entire + # list of transitions must be specified to add additional transitions. The + # existing list of transitions can be retrieved using the + # `fixed_fee_quantity_transitions` property on a subscription’s serialized price + # intervals. # # @overload price_intervals(subscription_id, add: nil, add_adjustments: nil, allow_invoice_credit_or_void: nil, edit: nil, edit_adjustments: nil, request_options: {}) # @@ -876,188 +876,188 @@ def price_intervals(subscription_id, params = {}) end # This endpoint can be used to change an existing subscription's plan. It returns - # the serialized updated subscription object. - # - # The body parameter `change_option` determines when the plan change occurrs. Orb - # supports three options: - # - # - `end_of_subscription_term`: changes the plan at the end of the existing plan's - # term. - # - Issuing this plan change request for a monthly subscription will keep the - # existing plan active until the start of the subsequent month. Issuing this - # plan change request for a yearly subscription will keep the existing plan - # active for the full year. Charges incurred in the remaining period will be - # invoiced as normal. - # - Example: The plan is billed monthly on the 1st of the month, the request is - # made on January 15th, so the plan will be changed on February 1st, and - # invoice will be issued on February 1st for the last month of the original - # plan. - # - `immediate`: changes the plan immediately. - # - Subscriptions that have their plan changed with this option will move to the - # new plan immediately, and be invoiced immediately. - # - This invoice will include any usage fees incurred in the billing period up - # to the change, along with any prorated recurring fees for the billing - # period, if applicable. - # - Example: The plan is billed monthly on the 1st of the month, the request is - # made on January 15th, so the plan will be changed on January 15th, and an - # invoice will be issued for the partial month, from January 1 to January 15, - # on the original plan. - # - `requested_date`: changes the plan on the requested date (`change_date`). - # - If no timezone is provided, the customer's timezone is used. The - # `change_date` body parameter is required if this option is chosen. - # - Example: The plan is billed monthly on the 1st of the month, the request is - # made on January 15th, with a requested `change_date` of February 15th, so - # the plan will be changed on February 15th, and invoices will be issued on - # February 1st and February 15th. - # - # Note that one of `plan_id` or `external_plan_id` is required in the request body - # for this operation. - # - # ## Customize your customer's subscriptions - # - # Prices and adjustments in a plan can be added, removed, or replaced on the - # subscription when you schedule the plan change. This is useful when a customer - # has prices that differ from the default prices for a specific plan. - # - # - # This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your - # Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans) - # - # - # ### Adding Prices - # - # To add prices, provide a list of objects with the key `add_prices`. An object in - # the list must specify an existing add-on price with a `price_id` or - # `external_price_id` field, or create a new add-on price by including an object - # with the key `price`, identical to what would be used in the request body for - # the [create price endpoint](/api-reference/price/create-price). See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations possible in this object. - # - # If the plan has phases, each object in the list must include a number with - # `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`. 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 - # to this price. - # - # Additionally, an object in the list can specify an optional `reference_id`. This - # ID can be used to reference this price when - # [adding an adjustment](#adding-adjustments) in the same API call. However the ID - # is _transient_ and cannot be used to refer to the price in future API calls. - # - # ### Removing Prices - # - # To remove prices, provide a list of objects with the key `remove_prices`. An - # object in the list must specify a plan price with either a `price_id` or - # `external_price_id` field. - # - # ### Replacing Prices - # - # To replace prices, provide a list of objects with the key `replace_prices`. An - # object in the list must specify a plan price to replace with the - # `replaces_price_id` key, and it must specify a price to replace it with by - # either referencing an existing add-on price with a `price_id` or - # `external_price_id` field, or by creating a new add-on price by including an - # object with the key `price`, identical to what would be used in the request body - # for the [create price endpoint](/api-reference/price/create-price). See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations possible in this object. - # - # For fixed fees, an object in the list can supply a `fixed_price_quantity` - # instead of a `price`, `price_id`, or `external_price_id` field. This will update - # only the quantity for the price, similar to the - # [Update price quantity](/api-reference/subscription/update-price-quantity) - # endpoint. - # - # The replacement price will have the same phase, if applicable, and the same - # start and end dates as the price it replaces. - # - # An object in the list can specify an optional `minimum_amount`, - # `maximum_amount`, or `discounts`. This will create adjustments which apply only - # to this price. - # - # Additionally, an object in the list can specify an optional `reference_id`. This - # ID can be used to reference the replacement price when - # [adding an adjustment](#adding-adjustments) in the same API call. However the ID - # is _transient_ and cannot be used to refer to the price in future API calls. - # - # ### Adding adjustments - # - # To add adjustments, provide a list of objects with the key `add_adjustments`. An - # object in the list must include an object with the key `adjustment`, identical - # to the adjustment object in the - # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - # - # If the plan has phases, each object in the list must include a number with - # `plan_phase_order` key to indicate which phase the adjustment should be added - # to. - # - # An object in the list can specify an optional `start_date` and optional - # `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 + # the serialized updated subscription object. + # + # The body parameter `change_option` determines when the plan change occurrs. Orb + # supports three options: + # + # - `end_of_subscription_term`: changes the plan at the end of the existing plan's + # term. + # - Issuing this plan change request for a monthly subscription will keep the + # existing plan active until the start of the subsequent month. Issuing this + # plan change request for a yearly subscription will keep the existing plan + # active for the full year. Charges incurred in the remaining period will be + # invoiced as normal. + # - Example: The plan is billed monthly on the 1st of the month, the request is + # made on January 15th, so the plan will be changed on February 1st, and + # invoice will be issued on February 1st for the last month of the original + # plan. + # - `immediate`: changes the plan immediately. + # - Subscriptions that have their plan changed with this option will move to the + # new plan immediately, and be invoiced immediately. + # - This invoice will include any usage fees incurred in the billing period up + # to the change, along with any prorated recurring fees for the billing + # period, if applicable. + # - Example: The plan is billed monthly on the 1st of the month, the request is + # made on January 15th, so the plan will be changed on January 15th, and an + # invoice will be issued for the partial month, from January 1 to January 15, + # on the original plan. + # - `requested_date`: changes the plan on the requested date (`change_date`). + # - If no timezone is provided, the customer's timezone is used. The + # `change_date` body parameter is required if this option is chosen. + # - Example: The plan is billed monthly on the 1st of the month, the request is + # made on January 15th, with a requested `change_date` of February 15th, so + # the plan will be changed on February 15th, and invoices will be issued on + # February 1st and February 15th. + # + # Note that one of `plan_id` or `external_plan_id` is required in the request body + # for this operation. + # + # ## Customize your customer's subscriptions + # + # Prices and adjustments in a plan can be added, removed, or replaced on the + # subscription when you schedule the plan change. This is useful when a customer + # has prices that differ from the default prices for a specific plan. + # + # + # This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your + # Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans) + # + # + # ### Adding Prices + # + # To add prices, provide a list of objects with the key `add_prices`. An object in + # the list must specify an existing add-on price with a `price_id` or + # `external_price_id` field, or create a new add-on price by including an object + # with the key `price`, identical to what would be used in the request body for + # the [create price endpoint](/api-reference/price/create-price). See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations possible in this object. + # + # If the plan has phases, each object in the list must include a number with + # `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`. 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 + # to this price. + # + # Additionally, an object in the list can specify an optional `reference_id`. This + # ID can be used to reference this price when + # [adding an adjustment](#adding-adjustments) in the same API call. However the ID + # is _transient_ and cannot be used to refer to the price in future API calls. + # + # ### Removing Prices + # + # To remove prices, provide a list of objects with the key `remove_prices`. An + # object in the list must specify a plan price with either a `price_id` or + # `external_price_id` field. + # + # ### Replacing Prices + # + # To replace prices, provide a list of objects with the key `replace_prices`. An + # object in the list must specify a plan price to replace with the + # `replaces_price_id` key, and it must specify a price to replace it with by + # either referencing an existing add-on price with a `price_id` or + # `external_price_id` field, or by creating a new add-on price by including an + # object with the key `price`, identical to what would be used in the request body + # for the [create price endpoint](/api-reference/price/create-price). See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations possible in this object. + # + # For fixed fees, an object in the list can supply a `fixed_price_quantity` + # instead of a `price`, `price_id`, or `external_price_id` field. This will update + # only the quantity for the price, similar to the + # [Update price quantity](/api-reference/subscription/update-price-quantity) + # endpoint. + # + # The replacement price will have the same phase, if applicable, and the same + # start and end dates as the price it replaces. + # + # An object in the list can specify an optional `minimum_amount`, + # `maximum_amount`, or `discounts`. This will create adjustments which apply only + # to this price. + # + # Additionally, an object in the list can specify an optional `reference_id`. This + # ID can be used to reference the replacement price when + # [adding an adjustment](#adding-adjustments) in the same API call. However the ID + # is _transient_ and cannot be used to refer to the price in future API calls. + # + # ### Adding adjustments + # + # To add adjustments, provide a list of objects with the key `add_adjustments`. An + # object in the list must include an object with the key `adjustment`, identical + # to the adjustment object in the + # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). + # + # If the plan has phases, each object in the list must include a number with + # `plan_phase_order` key to indicate which phase the adjustment should be added + # to. + # + # An object in the list can specify an optional `start_date` and optional + # `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 # - # To remove adjustments, provide a list of objects with the key - # `remove_adjustments`. An object in the list must include a key, `adjustment_id`, - # with the ID of the adjustment to be removed. + # To remove adjustments, provide a list of objects with the key + # `remove_adjustments`. An object in the list must include a key, `adjustment_id`, + # with the ID of the adjustment to be removed. # - # ### Replacing adjustments + # ### Replacing adjustments # - # To replace adjustments, provide a list of objects with the key - # `replace_adjustments`. An object in the list must specify a plan adjustment to - # replace with the `replaces_adjustment_id` key, and it must specify an adjustment - # to replace it with by including an object with the key `adjustment`, identical - # to the adjustment object in the - # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). + # To replace adjustments, provide a list of objects with the key + # `replace_adjustments`. An object in the list must specify a plan adjustment to + # replace with the `replaces_adjustment_id` key, and it must specify an adjustment + # to replace it with by including an object with the key `adjustment`, identical + # to the adjustment object in the + # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). # - # The replacement adjustment will have the same phase, if applicable, and the same - # start and end dates as the adjustment it replaces. + # The replacement adjustment will have the same phase, if applicable, and the same + # start and end dates as the adjustment it replaces. # - # ## Price overrides (DEPRECATED) + # ## Price overrides (DEPRECATED) # - # - # Price overrides are being phased out in favor adding/removing/replacing prices. (See - # [Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change)) - # - # - # Price overrides are used to update some or all prices in a plan for the specific - # subscription being created. This is useful when a new customer has negotiated a - # rate that is unique to the customer. + # + # Price overrides are being phased out in favor adding/removing/replacing prices. (See + # [Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change)) + # + # + # Price overrides are used to update some or all prices in a plan for the specific + # subscription being created. This is useful when a new customer has negotiated a + # rate that is unique to the customer. # - # To override prices, provide a list of objects with the key `price_overrides`. - # The price object in the list of overrides is expected to contain the existing - # price id, the `model_type` and configuration. (See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations.) The numerical values can be updated, but - # the billable metric, cadence, type, and name of a price can not be overridden. + # To override prices, provide a list of objects with the key `price_overrides`. + # The price object in the list of overrides is expected to contain the existing + # price id, the `model_type` and configuration. (See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations.) The numerical values can be updated, but + # the billable metric, cadence, type, and name of a price can not be overridden. # - # ### Maximums, and minimums + # ### Maximums, and minimums # - # Price overrides are used to update some or all prices in the target plan. - # Minimums and maximums, much like price overrides, can be useful when a new - # customer has negotiated a new or different minimum or maximum spend cap than the - # default for the plan. The request format for maximums and minimums is the same - # as those in [subscription creation](create-subscription). + # Price overrides are used to update some or all prices in the target plan. + # Minimums and maximums, much like price overrides, can be useful when a new + # customer has negotiated a new or different minimum or maximum spend cap than the + # default for the plan. The request format for maximums and minimums is the same + # as those in [subscription creation](create-subscription). # - # ## Scheduling multiple plan changes + # ## Scheduling multiple plan changes # - # When scheduling multiple plan changes with the same date, the latest plan change - # on that day takes effect. + # When scheduling multiple plan changes with the same date, the latest plan change + # on that day takes effect. # - # ## Prorations for in-advance fees + # ## Prorations for in-advance fees # - # By default, Orb calculates the prorated difference in any fixed fees when making - # a plan change, adjusting the customer balance as needed. For details on this - # behavior, see - # [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees). + # By default, Orb calculates the prorated difference in any fixed fees when making + # a plan change, adjusting the customer balance as needed. For details on this + # behavior, see + # [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees). # # @overload schedule_plan_change(subscription_id, change_option:, add_adjustments: nil, add_prices: nil, align_billing_with_plan_change_date: nil, auto_collection: nil, billing_cycle_alignment: nil, billing_cycle_anchor_configuration: nil, change_date: nil, coupon_redemption_code: nil, credits_overage_rate: nil, default_invoice_memo: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {}) # @@ -1105,7 +1105,7 @@ def schedule_plan_change(subscription_id, params) end # Manually trigger a phase, effective the given date (or the current time, if not - # specified). + # specified). # # @overload trigger_phase(subscription_id, allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {}) # @@ -1129,11 +1129,11 @@ def trigger_phase(subscription_id, params = {}) end # This endpoint can be used to unschedule any pending cancellations for a - # subscription. + # subscription. # - # To be eligible, the subscription must currently be active and have a future - # cancellation. This operation will turn on auto-renew, ensuring that the - # subscription does not end at the currently scheduled cancellation time. + # To be eligible, the subscription must currently be active and have a future + # cancellation. This operation will turn on auto-renew, ensuring that the + # subscription does not end at the currently scheduled cancellation time. # # @overload unschedule_cancellation(subscription_id, request_options: {}) # @@ -1153,10 +1153,10 @@ def unschedule_cancellation(subscription_id, params = {}) end # This endpoint can be used to clear scheduled updates to the quantity for a fixed - # fee. + # fee. # - # If there are no updates scheduled, a request validation error will be returned - # with a 400 status code. + # If there are no updates scheduled, a request validation error will be returned + # with a 400 status code. # # @overload unschedule_fixed_fee_quantity_updates(subscription_id, price_id:, request_options: {}) # @@ -1179,7 +1179,7 @@ def unschedule_fixed_fee_quantity_updates(subscription_id, params) end # This endpoint can be used to unschedule any pending plan changes on an existing - # subscription. + # subscription. # # @overload unschedule_pending_plan_changes(subscription_id, request_options: {}) # @@ -1200,18 +1200,18 @@ def unschedule_pending_plan_changes(subscription_id, params = {}) # This endpoint can be used to update the quantity for a fixed fee. # - # To be eligible, the subscription must currently be active and the price - # specified must be a fixed fee (not usage-based). This operation will immediately - # update the quantity for the fee, or if a `effective_date` is passed in, will - # update the quantity on the requested date at midnight in the customer's - # timezone. + # To be eligible, the subscription must currently be active and the price + # specified must be a fixed fee (not usage-based). This operation will immediately + # update the quantity for the fee, or if a `effective_date` is passed in, will + # update the quantity on the requested date at midnight in the customer's + # timezone. # - # In order to change the fixed fee quantity as of the next draft invoice for this - # subscription, pass `change_option=upcoming_invoice` without an `effective_date` - # specified. + # In order to change the fixed fee quantity as of the next draft invoice for this + # subscription, pass `change_option=upcoming_invoice` without an `effective_date` + # specified. # - # If the fee is an in-advance fixed fee, it will also issue an immediate invoice - # for the difference for the remainder of the billing period. + # If the fee is an in-advance fixed fee, it will also issue an immediate invoice + # for the difference for the remainder of the billing period. # # @overload update_fixed_fee_quantity(subscription_id, price_id:, quantity:, allow_invoice_credit_or_void: nil, change_option: nil, effective_date: nil, request_options: {}) # @@ -1238,23 +1238,23 @@ def update_fixed_fee_quantity(subscription_id, params) end # This endpoint is used to update the trial end date for a subscription. The new - # trial end date must be within the time range of the current plan (i.e. the new - # trial end date must be on or after the subscription's start date on the current - # plan, and on or before the subscription end date). - # - # In order to retroactively remove a trial completely, the end date can be set to - # the transition date of the subscription to this plan (or, if this is the first - # plan for this subscription, the subscription's start date). In order to end a - # trial immediately, the keyword `immediate` can be provided as the trial end - # date. - # - # By default, Orb will shift only the trial end date (and price intervals that - # start or end on the previous trial end date), and leave all other future price - # intervals untouched. If the `shift` parameter is set to `true`, Orb will shift - # all subsequent price and adjustment intervals by the same amount as the trial - # end date shift (so, e.g., if a plan change is scheduled or an add-on price was - # added, that change will be pushed back by the same amount of time the trial is - # extended). + # trial end date must be within the time range of the current plan (i.e. the new + # trial end date must be on or after the subscription's start date on the current + # plan, and on or before the subscription end date). + # + # In order to retroactively remove a trial completely, the end date can be set to + # the transition date of the subscription to this plan (or, if this is the first + # plan for this subscription, the subscription's start date). In order to end a + # trial immediately, the keyword `immediate` can be provided as the trial end + # date. + # + # By default, Orb will shift only the trial end date (and price intervals that + # start or end on the previous trial end date), and leave all other future price + # intervals untouched. If the `shift` parameter is set to `true`, Orb will shift + # all subsequent price and adjustment intervals by the same amount as the trial + # end date shift (so, e.g., if a plan change is scheduled or an add-on price was + # added, that change will be pushed back by the same amount of time the trial is + # extended). # # @overload update_trial(subscription_id, trial_end_date:, shift: nil, request_options: {}) # diff --git a/lib/orb/resources/top_level.rb b/lib/orb/resources/top_level.rb index e893d7f9..d651dc71 100644 --- a/lib/orb/resources/top_level.rb +++ b/lib/orb/resources/top_level.rb @@ -4,11 +4,11 @@ module Orb module Resources class TopLevel # This endpoint allows you to test your connection to the Orb API and check the - # validity of your API key, passed in the Authorization header. This is - # particularly useful for checking that your environment is set up properly, and - # is a great choice for connectors and integrations. + # validity of your API key, passed in the Authorization header. This is + # particularly useful for checking that your environment is set up properly, and + # is a great choice for connectors and integrations. # - # This API does not have any side-effects or return any Orb resources. + # This API does not have any side-effects or return any Orb resources. # # @overload ping(request_options: {}) # diff --git a/rbi/lib/orb/internal.rbi b/rbi/lib/orb/internal.rbi index 66560bd9..3041df91 100644 --- a/rbi/lib/orb/internal.rbi +++ b/rbi/lib/orb/internal.rbi @@ -4,7 +4,7 @@ module Orb # @api private module Internal # Due to the current WIP status of Shapes support in Sorbet, types referencing - # this alias might be refined in the future. + # this alias might be refined in the future. AnyHash = T.type_alias { T::Hash[Symbol, T.anything] } OMIT = T.let(T.anything, T.anything) diff --git a/rbi/lib/orb/internal/transport/base_client.rbi b/rbi/lib/orb/internal/transport/base_client.rbi index 24c8b504..cbcd1c95 100644 --- a/rbi/lib/orb/internal/transport/base_client.rbi +++ b/rbi/lib/orb/internal/transport/base_client.rbi @@ -148,7 +148,7 @@ module Orb private def send_request(request, redirect_count:, retry_count:, send_retry_header:); end # Execute the request specified by `req`. This is the method that all resource - # methods call into. + # methods call into. # # @overload request(method, path, query: {}, headers: {}, body: nil, unwrap: nil, page: nil, stream: nil, model: Orb::Internal::Type::Unknown, options: {}) sig do diff --git a/rbi/lib/orb/internal/transport/pooled_net_requester.rbi b/rbi/lib/orb/internal/transport/pooled_net_requester.rbi index 17d0e0b6..0c229b63 100644 --- a/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +++ b/rbi/lib/orb/internal/transport/pooled_net_requester.rbi @@ -17,7 +17,7 @@ module Orb end # from the golang stdlib - # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 + # https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49 KEEP_ALIVE_TIMEOUT = 30 class << self diff --git a/rbi/lib/orb/internal/type/base_model.rbi b/rbi/lib/orb/internal/type/base_model.rbi index a2bc8581..3260a99d 100644 --- a/rbi/lib/orb/internal/type/base_model.rbi +++ b/rbi/lib/orb/internal/type/base_model.rbi @@ -16,7 +16,7 @@ module Orb # @api private # # Assumes superclass fields are totally defined before fields are accessed / - # defined on subclasses. + # defined on subclasses. sig do returns( T::Hash[ @@ -99,7 +99,7 @@ module Orb # @api private # # `request_only` attributes not excluded from `.#coerce` when receiving responses - # even if well behaved servers should not send them + # even if well behaved servers should not send them sig { params(blk: T.proc.void).void } private def request_only(&blk); end @@ -138,33 +138,33 @@ module Orb end # Returns the raw value associated with the given key, if found. Otherwise, nil is - # returned. + # returned. # - # It is valid to lookup keys that are not in the API spec, for example to access - # undocumented features. This method does not parse response data into - # higher-level types. Lookup by anything other than a Symbol is an ArgumentError. + # It is valid to lookup keys that are not in the API spec, for example to access + # undocumented features. This method does not parse response data into + # higher-level types. Lookup by anything other than a Symbol is an ArgumentError. sig { params(key: Symbol).returns(T.nilable(T.anything)) } def [](key); end # Returns a Hash of the data underlying this object. O(1) # - # Keys are Symbols and values are the raw values from the response. The return - # value indicates which values were ever set on the object. i.e. there will be a - # key in this hash if they ever were, even if the set value was nil. + # Keys are Symbols and values are the raw values from the response. The return + # value indicates which values were ever set on the object. i.e. there will be a + # key in this hash if they ever were, even if the set value was nil. # - # This method is not recursive. The returned value is shared by the object, so it - # should not be mutated. + # This method is not recursive. The returned value is shared by the object, so it + # should not be mutated. sig { overridable.returns(Orb::Internal::AnyHash) } def to_h; end # Returns a Hash of the data underlying this object. O(1) # - # Keys are Symbols and values are the raw values from the response. The return - # value indicates which values were ever set on the object. i.e. there will be a - # key in this hash if they ever were, even if the set value was nil. + # Keys are Symbols and values are the raw values from the response. The return + # value indicates which values were ever set on the object. i.e. there will be a + # key in this hash if they ever were, even if the set value was nil. # - # This method is not recursive. The returned value is shared by the object, so it - # should not be mutated. + # This method is not recursive. The returned value is shared by the object, so it + # should not be mutated. sig { overridable.returns(Orb::Internal::AnyHash) } def to_hash; end diff --git a/rbi/lib/orb/internal/type/converter.rbi b/rbi/lib/orb/internal/type/converter.rbi index 640cb419..3f2b30a6 100644 --- a/rbi/lib/orb/internal/type/converter.rbi +++ b/rbi/lib/orb/internal/type/converter.rbi @@ -51,13 +51,13 @@ module Orb # # Based on `target`, transform `value` into `target`, to the extent possible: # - # 1. if the given `value` conforms to `target` already, return the given `value` - # 2. if it's possible and safe to convert the given `value` to `target`, then the - # converted value - # 3. otherwise, the given `value` unaltered + # 1. if the given `value` conforms to `target` already, return the given `value` + # 2. if it's possible and safe to convert the given `value` to `target`, then the + # converted value + # 3. otherwise, the given `value` unaltered # - # The coercion process is subject to improvement between minor release versions. - # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode + # The coercion process is subject to improvement between minor release versions. + # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode sig do params( target: Orb::Internal::Type::Converter::Input, @@ -70,24 +70,24 @@ module Orb target, value, # The `strictness` is one of `true`, `false`, or `:strong`. This informs the - # coercion strategy when we have to decide between multiple possible conversion - # targets: + # coercion strategy when we have to decide between multiple possible conversion + # targets: # - # - `true`: the conversion must be exact, with minimum coercion. - # - `false`: the conversion can be approximate, with some coercion. - # - `:strong`: the conversion must be exact, with no coercion, and raise an error - # if not possible. + # - `true`: the conversion must be exact, with minimum coercion. + # - `false`: the conversion can be approximate, with some coercion. + # - `:strong`: the conversion must be exact, with no coercion, and raise an error + # if not possible. # - # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For - # any given conversion attempt, the exactness will be updated based on how closely - # the value recursively matches the target type: + # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For + # any given conversion attempt, the exactness will be updated based on how closely + # the value recursively matches the target type: # - # - `yes`: the value can be converted to the target type with minimum coercion. - # - `maybe`: the value can be converted to the target type with some reasonable - # coercion. - # - `no`: the value cannot be converted to the target type. + # - `yes`: the value can be converted to the target type with minimum coercion. + # - `maybe`: the value can be converted to the target type with some reasonable + # coercion. + # - `no`: the value cannot be converted to the target type. # - # See implementation below for more details. + # See implementation below for more details. state: {strictness: true, exactness: {yes: 0, no: 0, maybe: 0}, branched: 0} ); end # @api private diff --git a/rbi/lib/orb/internal/type/enum.rbi b/rbi/lib/orb/internal/type/enum.rbi index 6729f4f7..284212fd 100644 --- a/rbi/lib/orb/internal/type/enum.rbi +++ b/rbi/lib/orb/internal/type/enum.rbi @@ -6,15 +6,15 @@ module Orb # @api private # # A value from among a specified list of options. OpenAPI enum values map to Ruby - # values in the SDK as follows: + # values in the SDK as follows: # - # 1. boolean => true | false - # 2. integer => Integer - # 3. float => Float - # 4. string => Symbol + # 1. boolean => true | false + # 2. integer => Integer + # 3. float => Float + # 4. string => Symbol # - # We can therefore convert string values to Symbols, but can't convert other - # values safely. + # We can therefore convert string values to Symbols, but can't convert other + # values safely. module Enum include Orb::Internal::Type::Converter @@ -37,7 +37,7 @@ module Orb # @api private # # Unlike with primitives, `Enum` additionally validates that the value is a member - # of the enum. + # of the enum. sig do override .params(value: T.any(String, Symbol, T.anything), state: Orb::Internal::Type::Converter::State) diff --git a/rbi/lib/orb/internal/util.rbi b/rbi/lib/orb/internal/util.rbi index d2e8eb9d..d3167fef 100644 --- a/rbi/lib/orb/internal/util.rbi +++ b/rbi/lib/orb/internal/util.rbi @@ -52,7 +52,7 @@ module Orb # @api private # # Recursively merge one hash with another. If the values at a given key are not - # both hashes, just take the new value. + # both hashes, just take the new value. sig do params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean) .returns(T.anything) diff --git a/rbi/lib/orb/models/alert.rbi b/rbi/lib/orb/models/alert.rbi index 5e4e9ae5..6acb0ac1 100644 --- a/rbi/lib/orb/models/alert.rbi +++ b/rbi/lib/orb/models/alert.rbi @@ -48,7 +48,7 @@ module Orb attr_writer :subscription # The thresholds that define the conditions under which the alert will be - # triggered. + # triggered. sig { returns(T.nilable(T::Array[Orb::Models::Alert::Threshold])) } attr_accessor :thresholds @@ -57,10 +57,10 @@ module Orb attr_accessor :type # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, - # usage, or credit balance and trigger webhooks when a threshold is exceeded. + # usage, or credit balance and trigger webhooks when a threshold is exceeded. # - # Alerts created through the API can be scoped to either customers or - # subscriptions. + # Alerts created through the API can be scoped to either customers or + # subscriptions. sig do params( id: String, @@ -141,8 +141,8 @@ module Orb attr_accessor :id # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. sig { returns(T.nilable(String)) } attr_accessor :external_plan_id @@ -192,13 +192,13 @@ module Orb class Threshold < Orb::Internal::Type::BaseModel # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. sig { returns(Float) } attr_accessor :value # Thresholds are used to define the conditions under which an alert will be - # triggered. + # triggered. sig { params(value: Float).returns(T.attached_class) } def self.new(value:); end diff --git a/rbi/lib/orb/models/alert_create_for_customer_params.rbi b/rbi/lib/orb/models/alert_create_for_customer_params.rbi index 49cb0856..1a02de4b 100644 --- a/rbi/lib/orb/models/alert_create_for_customer_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_customer_params.rbi @@ -63,13 +63,13 @@ module Orb class Threshold < Orb::Internal::Type::BaseModel # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. sig { returns(Float) } attr_accessor :value # Thresholds are used to define the conditions under which an alert will be - # triggered. + # triggered. sig { params(value: Float).returns(T.attached_class) } def self.new(value:); end diff --git a/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi b/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi index 639564fe..cc729aa2 100644 --- a/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi @@ -65,13 +65,13 @@ module Orb class Threshold < Orb::Internal::Type::BaseModel # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. sig { returns(Float) } attr_accessor :value # Thresholds are used to define the conditions under which an alert will be - # triggered. + # triggered. sig { params(value: Float).returns(T.attached_class) } def self.new(value:); end diff --git a/rbi/lib/orb/models/alert_create_for_subscription_params.rbi b/rbi/lib/orb/models/alert_create_for_subscription_params.rbi index 5db663ee..6e44c043 100644 --- a/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_subscription_params.rbi @@ -44,13 +44,13 @@ module Orb class Threshold < Orb::Internal::Type::BaseModel # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. sig { returns(Float) } attr_accessor :value # Thresholds are used to define the conditions under which an alert will be - # triggered. + # triggered. sig { params(value: Float).returns(T.attached_class) } def self.new(value:); end diff --git a/rbi/lib/orb/models/alert_list_params.rbi b/rbi/lib/orb/models/alert_list_params.rbi index 895dd96c..38f8759b 100644 --- a/rbi/lib/orb/models/alert_list_params.rbi +++ b/rbi/lib/orb/models/alert_list_params.rbi @@ -19,7 +19,7 @@ module Orb attr_accessor :created_at_lte # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/alert_update_params.rbi b/rbi/lib/orb/models/alert_update_params.rbi index 2a987b37..9c10493b 100644 --- a/rbi/lib/orb/models/alert_update_params.rbi +++ b/rbi/lib/orb/models/alert_update_params.rbi @@ -29,13 +29,13 @@ module Orb class Threshold < Orb::Internal::Type::BaseModel # The value at which an alert will fire. For credit balance alerts, the alert will - # fire at or below this value. For usage and cost alerts, the alert will fire at - # or above this value. + # fire at or below this value. For usage and cost alerts, the alert will fire at + # or above this value. sig { returns(Float) } attr_accessor :value # Thresholds are used to define the conditions under which an alert will be - # triggered. + # triggered. sig { params(value: Float).returns(T.attached_class) } def self.new(value:); end diff --git a/rbi/lib/orb/models/amount_discount.rbi b/rbi/lib/orb/models/amount_discount.rbi index 1ed6115c..a5ca1de8 100644 --- a/rbi/lib/orb/models/amount_discount.rbi +++ b/rbi/lib/orb/models/amount_discount.rbi @@ -8,7 +8,7 @@ module Orb attr_accessor :amount_discount # List of price_ids that this discount applies to. For plan/plan phase discounts, - # this can be a subset of prices. + # this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids diff --git a/rbi/lib/orb/models/billable_metric.rbi b/rbi/lib/orb/models/billable_metric.rbi index 72cdb418..4616af64 100644 --- a/rbi/lib/orb/models/billable_metric.rbi +++ b/rbi/lib/orb/models/billable_metric.rbi @@ -10,8 +10,8 @@ module Orb attr_accessor :description # The Item resource represents a sellable product or good. Items are associated - # with all line items, billable metrics, and prices and are used for defining - # external sync behavior for invoices and tax calculation purposes. + # with all line items, billable metrics, and prices and are used for defining + # external sync behavior for invoices and tax calculation purposes. sig { returns(Orb::Models::Item) } attr_reader :item @@ -19,9 +19,9 @@ module Orb attr_writer :item # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -32,8 +32,8 @@ module Orb attr_accessor :status # The Metric resource represents a calculation of a quantity based on events. - # Metrics are defined by the query that transforms raw usage events into - # meaningful values for your customers. + # Metrics are defined by the query that transforms raw usage events into + # meaningful values for your customers. sig do params( id: String, diff --git a/rbi/lib/orb/models/coupon.rbi b/rbi/lib/orb/models/coupon.rbi index 31ef617e..3e0a1644 100644 --- a/rbi/lib/orb/models/coupon.rbi +++ b/rbi/lib/orb/models/coupon.rbi @@ -8,7 +8,7 @@ module Orb attr_accessor :id # An archived coupon can no longer be redeemed. Active coupons will have a value - # of null for `archived_at`; this field will be non-null for archived coupons. + # of null for `archived_at`; this field will be non-null for archived coupons. sig { returns(T.nilable(Time)) } attr_accessor :archived_at @@ -16,12 +16,12 @@ module Orb attr_accessor :discount # This allows for a coupon's discount to apply for a limited time (determined in - # months); a `null` value here means "unlimited time". + # months); a `null` value here means "unlimited time". sig { returns(T.nilable(Integer)) } attr_accessor :duration_in_months # The maximum number of redemptions allowed for this coupon before it is - # exhausted; `null` here means "unlimited". + # exhausted; `null` here means "unlimited". sig { returns(T.nilable(Integer)) } attr_accessor :max_redemptions @@ -34,10 +34,10 @@ module Orb attr_accessor :times_redeemed # A coupon represents a reusable discount configuration that can be applied either - # as a fixed or percentage amount to an invoice or subscription. Coupons are - # activated using a redemption code, which applies the discount to a subscription - # or invoice. The duration of a coupon determines how long it remains available - # for use by end users. + # as a fixed or percentage amount to an invoice or subscription. Coupons are + # activated using a redemption code, which applies the discount to a subscription + # or invoice. The duration of a coupon determines how long it remains available + # for use by end users. sig do params( id: String, diff --git a/rbi/lib/orb/models/coupon_create_params.rbi b/rbi/lib/orb/models/coupon_create_params.rbi index 906a14d3..e561b3c8 100644 --- a/rbi/lib/orb/models/coupon_create_params.rbi +++ b/rbi/lib/orb/models/coupon_create_params.rbi @@ -21,12 +21,12 @@ module Orb attr_accessor :redemption_code # This allows for a coupon's discount to apply for a limited time (determined in - # months); a `null` value here means "unlimited time". + # months); a `null` value here means "unlimited time". sig { returns(T.nilable(Integer)) } attr_accessor :duration_in_months # The maximum number of redemptions allowed for this coupon before it is - # exhausted;`null` here means "unlimited". + # exhausted;`null` here means "unlimited". sig { returns(T.nilable(Integer)) } attr_accessor :max_redemptions diff --git a/rbi/lib/orb/models/coupon_list_params.rbi b/rbi/lib/orb/models/coupon_list_params.rbi index 85f1ecc6..d323ee34 100644 --- a/rbi/lib/orb/models/coupon_list_params.rbi +++ b/rbi/lib/orb/models/coupon_list_params.rbi @@ -7,7 +7,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor @@ -23,7 +23,7 @@ module Orb attr_accessor :redemption_code # Show archived coupons as well (by default, this endpoint only returns active - # coupons). + # coupons). sig { returns(T.nilable(T::Boolean)) } attr_accessor :show_archived diff --git a/rbi/lib/orb/models/coupons/subscription_list_params.rbi b/rbi/lib/orb/models/coupons/subscription_list_params.rbi index 23ee3a0c..cccbc4ac 100644 --- a/rbi/lib/orb/models/coupons/subscription_list_params.rbi +++ b/rbi/lib/orb/models/coupons/subscription_list_params.rbi @@ -8,7 +8,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/credit_note.rbi b/rbi/lib/orb/models/credit_note.rbi index fcaf2350..1ba9b6ee 100644 --- a/rbi/lib/orb/models/credit_note.rbi +++ b/rbi/lib/orb/models/credit_note.rbi @@ -79,7 +79,7 @@ module Orb attr_writer :discounts # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has - # been applied to a particular invoice. + # been applied to a particular invoice. sig do params( id: String, diff --git a/rbi/lib/orb/models/credit_note_list_params.rbi b/rbi/lib/orb/models/credit_note_list_params.rbi index 628e1e25..14acc9a0 100644 --- a/rbi/lib/orb/models/credit_note_list_params.rbi +++ b/rbi/lib/orb/models/credit_note_list_params.rbi @@ -19,7 +19,7 @@ module Orb attr_accessor :created_at_lte # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/customer.rbi b/rbi/lib/orb/models/customer.rbi index c559e396..1168046f 100644 --- a/rbi/lib/orb/models/customer.rbi +++ b/rbi/lib/orb/models/customer.rbi @@ -32,8 +32,8 @@ module Orb attr_accessor :currency # A valid customer email, to be used for notifications. When Orb triggers payment - # through a payment gateway, this email will be used for any automatically issued - # receipts. + # through a payment gateway, this email will be used for any automatically issued + # receipts. sig { returns(String) } attr_accessor :email @@ -44,8 +44,8 @@ module Orb attr_accessor :exempt_from_automated_tax # An optional user-defined ID for this customer resource, used throughout the - # system as an alias for this Customer. Use this field to identify a customer by - # an existing identifier in your system. + # system as an alias for this Customer. Use this field to identify a customer by + # an existing identifier in your system. sig { returns(T.nilable(String)) } attr_accessor :external_customer_id @@ -57,9 +57,9 @@ module Orb attr_writer :hierarchy # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -68,13 +68,13 @@ module Orb attr_accessor :name # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode, the connection must first be configured in the Orb - # webapp. + # When not in test mode, the connection must first be configured in the Orb + # webapp. sig { returns(T.nilable(Orb::Models::Customer::PaymentProvider::TaggedSymbol)) } attr_accessor :payment_provider # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. sig { returns(T.nilable(String)) } attr_accessor :payment_provider_id @@ -91,110 +91,110 @@ module Orb attr_writer :shipping_address # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig { returns(T.nilable(Orb::Models::Customer::TaxID)) } attr_reader :tax_id @@ -202,8 +202,8 @@ module Orb attr_writer :tax_id # A timezone identifier from the IANA timezone database, such as - # "America/Los_Angeles". This "defaults to your account's timezone if not set. - # This cannot be changed after customer creation. + # "America/Los_Angeles". This "defaults to your account's timezone if not set. + # This cannot be changed after customer creation. sig { returns(String) } attr_accessor :timezone @@ -230,23 +230,23 @@ module Orb attr_writer :reporting_configuration # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig do params( id: String, @@ -438,8 +438,8 @@ module Orb end # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode, the connection must first be configured in the Orb - # webapp. + # When not in test mode, the connection must first be configured in the Orb + # webapp. module PaymentProvider extend Orb::Internal::Type::Enum @@ -515,110 +515,110 @@ module Orb attr_accessor :value # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig do params( country: Orb::Models::Customer::TaxID::Country::OrSymbol, diff --git a/rbi/lib/orb/models/customer_create_params.rbi b/rbi/lib/orb/models/customer_create_params.rbi index bbced843..3b720d55 100644 --- a/rbi/lib/orb/models/customer_create_params.rbi +++ b/rbi/lib/orb/models/customer_create_params.rbi @@ -7,8 +7,8 @@ module Orb include Orb::Internal::Type::RequestParameters # A valid customer email, to be used for notifications. When Orb triggers payment - # through a payment gateway, this email will be used for any automatically issued - # receipts. + # through a payment gateway, this email will be used for any automatically issued + # receipts. sig { returns(String) } attr_accessor :email @@ -28,13 +28,13 @@ module Orb attr_writer :accounting_sync_configuration # Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. + # addresses will be CC'd for customer communications. sig { returns(T.nilable(T::Array[String])) } attr_accessor :additional_emails # Used to determine if invoices for this customer will automatically attempt to - # charge a saved payment method, if available. This parameter defaults to `True` - # when a payment provider is provided on customer creation. + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -50,7 +50,7 @@ module Orb attr_writer :billing_address # An ISO 4217 currency string used for the customer's invoices and balance. If not - # set at creation time, will be set at subscription creation time. + # set at creation time, will be set at subscription creation time. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -58,8 +58,8 @@ module Orb attr_accessor :email_delivery # An optional user-defined ID for this customer resource, used throughout the - # system as an alias for this Customer. Use this field to identify a customer by - # an existing identifier in your system. + # system as an alias for this Customer. Use this field to identify a customer by + # an existing identifier in your system. sig { returns(T.nilable(String)) } attr_accessor :external_customer_id @@ -74,19 +74,19 @@ module Orb attr_writer :hierarchy # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode, the connection must first be configured in the Orb - # webapp. + # When not in test mode, the connection must first be configured in the Orb + # webapp. sig { returns(T.nilable(Orb::Models::CustomerCreateParams::PaymentProvider::OrSymbol)) } attr_accessor :payment_provider # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. sig { returns(T.nilable(String)) } attr_accessor :payment_provider_id @@ -125,110 +125,110 @@ module Orb attr_accessor :tax_configuration # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig { returns(T.nilable(Orb::Models::CustomerCreateParams::TaxID)) } attr_reader :tax_id @@ -236,8 +236,8 @@ module Orb attr_writer :tax_id # A timezone identifier from the IANA timezone database, such as - # `"America/Los_Angeles"`. This defaults to your account's timezone if not set. - # This cannot be changed after customer creation. + # `"America/Los_Angeles"`. This defaults to your account's timezone if not set. + # This cannot be changed after customer creation. sig { returns(T.nilable(String)) } attr_accessor :timezone @@ -428,7 +428,7 @@ module Orb class Hierarchy < Orb::Internal::Type::BaseModel # A list of child customer IDs to add to the hierarchy. The desired child - # customers must not already be part of another hierarchy. + # customers must not already be part of another hierarchy. sig { returns(T.nilable(T::Array[String])) } attr_reader :child_customer_ids @@ -436,7 +436,7 @@ module Orb attr_writer :child_customer_ids # The ID of the parent customer in the hierarchy. The desired parent customer must - # not be a child of another customer. + # not be a child of another customer. sig { returns(T.nilable(String)) } attr_accessor :parent_customer_id @@ -454,8 +454,8 @@ module Orb end # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode, the connection must first be configured in the Orb - # webapp. + # When not in test mode, the connection must first be configured in the Orb + # webapp. module PaymentProvider extend Orb::Internal::Type::Enum @@ -597,110 +597,110 @@ module Orb attr_accessor :value # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig do params( country: Orb::Models::CustomerCreateParams::TaxID::Country::OrSymbol, diff --git a/rbi/lib/orb/models/customer_list_params.rbi b/rbi/lib/orb/models/customer_list_params.rbi index 53c72cf9..4892498c 100644 --- a/rbi/lib/orb/models/customer_list_params.rbi +++ b/rbi/lib/orb/models/customer_list_params.rbi @@ -19,7 +19,7 @@ module Orb attr_accessor :created_at_lte # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/customer_update_by_external_id_params.rbi b/rbi/lib/orb/models/customer_update_by_external_id_params.rbi index 3b1966c1..b6cb5b8e 100644 --- a/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customer_update_by_external_id_params.rbi @@ -20,13 +20,13 @@ module Orb attr_writer :accounting_sync_configuration # Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. + # addresses will be CC'd for customer communications. sig { returns(T.nilable(T::Array[String])) } attr_accessor :additional_emails # Used to determine if invoices for this customer will automatically attempt to - # charge a saved payment method, if available. This parameter defaults to `True` - # when a payment provider is provided on customer creation. + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -42,7 +42,7 @@ module Orb attr_writer :billing_address # An ISO 4217 currency string used for the customer's invoices and balance. If not - # set at creation time, will be set at subscription creation time. + # set at creation time, will be set at subscription creation time. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -54,7 +54,7 @@ module Orb attr_accessor :email_delivery # The external customer ID. This can only be set if empty and the customer has no - # past or current subscriptions. + # past or current subscriptions. sig { returns(T.nilable(String)) } attr_accessor :external_customer_id @@ -71,8 +71,8 @@ module Orb attr_writer :hierarchy # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -81,17 +81,17 @@ module Orb attr_accessor :name # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. sig { returns(T.nilable(Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::OrSymbol)) } attr_accessor :payment_provider # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. sig { returns(T.nilable(String)) } attr_accessor :payment_provider_id @@ -132,110 +132,110 @@ module Orb attr_accessor :tax_configuration # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig { returns(T.nilable(Orb::Models::CustomerUpdateByExternalIDParams::TaxID)) } attr_reader :tax_id @@ -439,7 +439,7 @@ module Orb class Hierarchy < Orb::Internal::Type::BaseModel # A list of child customer IDs to add to the hierarchy. The desired child - # customers must not already be part of another hierarchy. + # customers must not already be part of another hierarchy. sig { returns(T.nilable(T::Array[String])) } attr_reader :child_customer_ids @@ -447,7 +447,7 @@ module Orb attr_writer :child_customer_ids # The ID of the parent customer in the hierarchy. The desired parent customer must - # not be a child of another customer. + # not be a child of another customer. sig { returns(T.nilable(String)) } attr_accessor :parent_customer_id @@ -465,12 +465,12 @@ module Orb end # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. module PaymentProvider extend Orb::Internal::Type::Enum @@ -617,110 +617,110 @@ module Orb attr_accessor :value # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig do params( country: Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::OrSymbol, diff --git a/rbi/lib/orb/models/customer_update_params.rbi b/rbi/lib/orb/models/customer_update_params.rbi index 0b35e98d..9f2151a8 100644 --- a/rbi/lib/orb/models/customer_update_params.rbi +++ b/rbi/lib/orb/models/customer_update_params.rbi @@ -18,13 +18,13 @@ module Orb attr_writer :accounting_sync_configuration # Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. + # addresses will be CC'd for customer communications. sig { returns(T.nilable(T::Array[String])) } attr_accessor :additional_emails # Used to determine if invoices for this customer will automatically attempt to - # charge a saved payment method, if available. This parameter defaults to `True` - # when a payment provider is provided on customer creation. + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -40,7 +40,7 @@ module Orb attr_writer :billing_address # An ISO 4217 currency string used for the customer's invoices and balance. If not - # set at creation time, will be set at subscription creation time. + # set at creation time, will be set at subscription creation time. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -52,7 +52,7 @@ module Orb attr_accessor :email_delivery # The external customer ID. This can only be set if empty and the customer has no - # past or current subscriptions. + # past or current subscriptions. sig { returns(T.nilable(String)) } attr_accessor :external_customer_id @@ -67,8 +67,8 @@ module Orb attr_writer :hierarchy # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -77,17 +77,17 @@ module Orb attr_accessor :name # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. sig { returns(T.nilable(Orb::Models::CustomerUpdateParams::PaymentProvider::OrSymbol)) } attr_accessor :payment_provider # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. sig { returns(T.nilable(String)) } attr_accessor :payment_provider_id @@ -126,110 +126,110 @@ module Orb attr_accessor :tax_configuration # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig { returns(T.nilable(Orb::Models::CustomerUpdateParams::TaxID)) } attr_reader :tax_id @@ -420,7 +420,7 @@ module Orb class Hierarchy < Orb::Internal::Type::BaseModel # A list of child customer IDs to add to the hierarchy. The desired child - # customers must not already be part of another hierarchy. + # customers must not already be part of another hierarchy. sig { returns(T.nilable(T::Array[String])) } attr_reader :child_customer_ids @@ -428,7 +428,7 @@ module Orb attr_writer :child_customer_ids # The ID of the parent customer in the hierarchy. The desired parent customer must - # not be a child of another customer. + # not be a child of another customer. sig { returns(T.nilable(String)) } attr_accessor :parent_customer_id @@ -446,12 +446,12 @@ module Orb end # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. module PaymentProvider extend Orb::Internal::Type::Enum @@ -593,110 +593,110 @@ module Orb attr_accessor :value # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig do params( country: Orb::Models::CustomerUpdateParams::TaxID::Country::OrSymbol, diff --git a/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi b/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi index e02c241e..f7449a06 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi @@ -37,7 +37,7 @@ module Orb attr_accessor :description # The new value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. sig { returns(String) } attr_accessor :ending_balance @@ -55,7 +55,7 @@ module Orb attr_writer :invoice # The original value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. sig { returns(String) } attr_accessor :starting_balance diff --git a/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi b/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi index b0652328..514551fb 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi @@ -8,7 +8,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi b/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi index d773104e..bd94dca4 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi @@ -37,7 +37,7 @@ module Orb attr_accessor :description # The new value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. sig { returns(String) } attr_accessor :ending_balance @@ -53,7 +53,7 @@ module Orb attr_writer :invoice # The original value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. sig { returns(String) } attr_accessor :starting_balance diff --git a/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi index bfc3a560..95db8bdf 100644 --- a/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi @@ -20,9 +20,9 @@ module Orb attr_accessor :timeframe_start # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. sig { returns(T.nilable(Orb::Models::Customers::CostListByExternalIDParams::ViewMode::OrSymbol)) } attr_accessor :view_mode @@ -60,9 +60,9 @@ module Orb def to_hash; end # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. module ViewMode extend Orb::Internal::Type::Enum diff --git a/rbi/lib/orb/models/customers/cost_list_params.rbi b/rbi/lib/orb/models/customers/cost_list_params.rbi index 25aa7fe4..eeddc27d 100644 --- a/rbi/lib/orb/models/customers/cost_list_params.rbi +++ b/rbi/lib/orb/models/customers/cost_list_params.rbi @@ -20,9 +20,9 @@ module Orb attr_accessor :timeframe_start # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. sig { returns(T.nilable(Orb::Models::Customers::CostListParams::ViewMode::OrSymbol)) } attr_accessor :view_mode @@ -60,9 +60,9 @@ module Orb def to_hash; end # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. module ViewMode extend Orb::Internal::Type::Enum diff --git a/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi index 1ca12eea..51600664 100644 --- a/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi @@ -12,12 +12,12 @@ module Orb attr_accessor :currency # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor # If set to True, all expired and depleted blocks, as well as active block will be - # returned. + # returned. sig { returns(T.nilable(T::Boolean)) } attr_reader :include_all_blocks diff --git a/rbi/lib/orb/models/customers/credit_list_params.rbi b/rbi/lib/orb/models/customers/credit_list_params.rbi index e21c8f52..806470ec 100644 --- a/rbi/lib/orb/models/customers/credit_list_params.rbi +++ b/rbi/lib/orb/models/customers/credit_list_params.rbi @@ -12,12 +12,12 @@ module Orb attr_accessor :currency # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor # If set to True, all expired and depleted blocks, as well as active block will be - # returned. + # returned. sig { returns(T.nilable(T::Boolean)) } attr_reader :include_all_blocks diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi index a07a9251..25b77751 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi @@ -9,7 +9,7 @@ module Orb include Orb::Internal::Type::RequestParameters # The number of credits to effect. Note that this is required for increment, - # decrement or void operations. + # decrement or void operations. sig { returns(Float) } attr_accessor :amount @@ -17,18 +17,18 @@ module Orb attr_accessor :entry_type # The currency or custom pricing unit to use for this ledger entry. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. sig { returns(T.nilable(String)) } attr_accessor :currency # Optional metadata that can be specified when adding ledger results via the API. - # For example, this can be used to note an increment refers to trial credits, or - # for noting corrections as a result of an incident, etc. + # For example, this can be used to note an increment refers to trial credits, or + # for noting corrections as a result of an incident, etc. sig { returns(T.nilable(String)) } attr_accessor :description # An ISO 8601 format date that denotes when this credit balance should become - # available for use. + # available for use. sig { returns(T.nilable(Time)) } attr_accessor :effective_date @@ -37,9 +37,9 @@ module Orb attr_accessor :expiry_date # Passing `invoice_settings` automatically generates an invoice for the newly - # added credits. If `invoice_settings` is passed, you must specify - # per_unit_cost_basis, as the calculation of the invoice total is done on that - # basis. + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. sig { returns(T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings)) } attr_reader :invoice_settings @@ -57,19 +57,19 @@ module Orb attr_writer :invoice_settings # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # Can only be specified when entry_type=increment. How much, in the customer's - # currency, a customer paid for a single credit in this block + # currency, a customer paid for a single credit in this block sig { returns(T.nilable(String)) } attr_accessor :per_unit_cost_basis # A future date (specified in YYYY-MM-DD format) used for expiration change, - # denoting when credits transferred (as part of a partial block expiration) should - # expire. + # denoting when credits transferred (as part of a partial block expiration) should + # expire. sig { returns(Date) } attr_accessor :target_expiry_date @@ -176,13 +176,13 @@ module Orb class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. sig { returns(T::Boolean) } attr_accessor :auto_collection # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. sig { returns(Integer) } attr_accessor :net_terms @@ -191,7 +191,7 @@ module Orb attr_accessor :memo # If true, the new credit block will require that the corresponding invoice is - # paid before it can be drawn down from. + # paid before it can be drawn down from. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment @@ -199,9 +199,9 @@ module Orb attr_writer :require_successful_payment # Passing `invoice_settings` automatically generates an invoice for the newly - # added credits. If `invoice_settings` is passed, you must specify - # per_unit_cost_basis, as the calculation of the invoice total is done on that - # basis. + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. sig do params( auto_collection: T::Boolean, diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi index 9826f4e2..5c2422a1 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi @@ -5,7 +5,7 @@ module Orb module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid - # credits within Orb. + # credits within Orb. module LedgerCreateEntryByExternalIDResponse extend Orb::Internal::Type::Union @@ -78,9 +78,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -298,9 +298,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -536,9 +536,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -762,9 +762,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -978,9 +978,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1210,9 +1210,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1448,9 +1448,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi index 9f419389..a258f7b6 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi @@ -9,7 +9,7 @@ module Orb include Orb::Internal::Type::RequestParameters # The number of credits to effect. Note that this is required for increment, - # decrement or void operations. + # decrement or void operations. sig { returns(Float) } attr_accessor :amount @@ -17,18 +17,18 @@ module Orb attr_accessor :entry_type # The currency or custom pricing unit to use for this ledger entry. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. sig { returns(T.nilable(String)) } attr_accessor :currency # Optional metadata that can be specified when adding ledger results via the API. - # For example, this can be used to note an increment refers to trial credits, or - # for noting corrections as a result of an incident, etc. + # For example, this can be used to note an increment refers to trial credits, or + # for noting corrections as a result of an incident, etc. sig { returns(T.nilable(String)) } attr_accessor :description # An ISO 8601 format date that denotes when this credit balance should become - # available for use. + # available for use. sig { returns(T.nilable(Time)) } attr_accessor :effective_date @@ -37,9 +37,9 @@ module Orb attr_accessor :expiry_date # Passing `invoice_settings` automatically generates an invoice for the newly - # added credits. If `invoice_settings` is passed, you must specify - # per_unit_cost_basis, as the calculation of the invoice total is done on that - # basis. + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. sig { returns(T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings)) } attr_reader :invoice_settings @@ -54,19 +54,19 @@ module Orb attr_writer :invoice_settings # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # Can only be specified when entry_type=increment. How much, in the customer's - # currency, a customer paid for a single credit in this block + # currency, a customer paid for a single credit in this block sig { returns(T.nilable(String)) } attr_accessor :per_unit_cost_basis # A future date (specified in YYYY-MM-DD format) used for expiration change, - # denoting when credits transferred (as part of a partial block expiration) should - # expire. + # denoting when credits transferred (as part of a partial block expiration) should + # expire. sig { returns(Date) } attr_accessor :target_expiry_date @@ -155,13 +155,13 @@ module Orb class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. sig { returns(T::Boolean) } attr_accessor :auto_collection # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. sig { returns(Integer) } attr_accessor :net_terms @@ -170,7 +170,7 @@ module Orb attr_accessor :memo # If true, the new credit block will require that the corresponding invoice is - # paid before it can be drawn down from. + # paid before it can be drawn down from. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment @@ -178,9 +178,9 @@ module Orb attr_writer :require_successful_payment # Passing `invoice_settings` automatically generates an invoice for the newly - # added credits. If `invoice_settings` is passed, you must specify - # per_unit_cost_basis, as the calculation of the invoice total is done on that - # basis. + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. sig do params( auto_collection: T::Boolean, diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi index d208463e..e71029c7 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi @@ -5,7 +5,7 @@ module Orb module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid - # credits within Orb. + # credits within Orb. module LedgerCreateEntryResponse extend Orb::Internal::Type::Union @@ -70,9 +70,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -282,9 +282,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -516,9 +516,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -742,9 +742,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -954,9 +954,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1174,9 +1174,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1404,9 +1404,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi index 7bcdbe25..039f9828 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi @@ -25,7 +25,7 @@ module Orb attr_accessor :currency # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi index 08c60827..7e301c23 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi @@ -5,7 +5,7 @@ module Orb module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid - # credits within Orb. + # credits within Orb. module LedgerListByExternalIDResponse extend Orb::Internal::Type::Union @@ -74,9 +74,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -290,9 +290,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -528,9 +528,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -754,9 +754,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -966,9 +966,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1198,9 +1198,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1432,9 +1432,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi index 45d6d1a4..a95a4a24 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi @@ -25,7 +25,7 @@ module Orb attr_accessor :currency # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi index fa6dd1ad..8668a3c5 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi @@ -5,7 +5,7 @@ module Orb module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid - # credits within Orb. + # credits within Orb. module LedgerListResponse extend Orb::Internal::Type::Union @@ -70,9 +70,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -278,9 +278,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -504,9 +504,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -722,9 +722,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -930,9 +930,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1150,9 +1150,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1376,9 +1376,9 @@ module Orb attr_accessor :ledger_sequence_number # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi index 976e36d0..e83dcc6e 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi @@ -13,7 +13,7 @@ module Orb attr_accessor :amount # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. sig { returns(String) } attr_accessor :currency @@ -37,17 +37,17 @@ module Orb attr_accessor :per_unit_cost_basis # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. sig { returns(String) } attr_accessor :threshold # The date from which the top-up is active. If unspecified, the top-up is active - # immediately. + # immediately. sig { returns(T.nilable(Time)) } attr_accessor :active_from # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. sig { returns(T.nilable(Integer)) } attr_accessor :expires_after @@ -107,13 +107,13 @@ module Orb class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. sig { returns(T::Boolean) } attr_accessor :auto_collection # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. sig { returns(Integer) } attr_accessor :net_terms @@ -122,7 +122,7 @@ module Orb attr_accessor :memo # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi index 64f58954..a91b0b9b 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi @@ -13,7 +13,7 @@ module Orb attr_accessor :amount # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. sig { returns(String) } attr_accessor :currency @@ -37,12 +37,12 @@ module Orb attr_accessor :per_unit_cost_basis # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. sig { returns(String) } attr_accessor :threshold # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. sig { returns(T.nilable(Integer)) } attr_accessor :expires_after @@ -103,13 +103,13 @@ module Orb class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. sig { returns(T::Boolean) } attr_accessor :auto_collection # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. sig { returns(Integer) } attr_accessor :net_terms @@ -118,7 +118,7 @@ module Orb attr_accessor :memo # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi index 8c2c38ee..59b790a3 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi @@ -13,7 +13,7 @@ module Orb attr_accessor :amount # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. sig { returns(String) } attr_accessor :currency @@ -34,17 +34,17 @@ module Orb attr_accessor :per_unit_cost_basis # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. sig { returns(String) } attr_accessor :threshold # The date from which the top-up is active. If unspecified, the top-up is active - # immediately. + # immediately. sig { returns(T.nilable(Time)) } attr_accessor :active_from # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. sig { returns(T.nilable(Integer)) } attr_accessor :expires_after @@ -97,13 +97,13 @@ module Orb class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. sig { returns(T::Boolean) } attr_accessor :auto_collection # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. sig { returns(Integer) } attr_accessor :net_terms @@ -112,7 +112,7 @@ module Orb attr_accessor :memo # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi index 6a3daba5..a96beb29 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi @@ -13,7 +13,7 @@ module Orb attr_accessor :amount # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. sig { returns(String) } attr_accessor :currency @@ -34,12 +34,12 @@ module Orb attr_accessor :per_unit_cost_basis # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. sig { returns(String) } attr_accessor :threshold # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. sig { returns(T.nilable(Integer)) } attr_accessor :expires_after @@ -89,13 +89,13 @@ module Orb class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. sig { returns(T::Boolean) } attr_accessor :auto_collection # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. sig { returns(Integer) } attr_accessor :net_terms @@ -104,7 +104,7 @@ module Orb attr_accessor :memo # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi index d6a10505..f3ae38cb 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi @@ -9,7 +9,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi index f468cf01..c767f7ac 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi @@ -13,7 +13,7 @@ module Orb attr_accessor :amount # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. sig { returns(String) } attr_accessor :currency @@ -37,12 +37,12 @@ module Orb attr_accessor :per_unit_cost_basis # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. sig { returns(String) } attr_accessor :threshold # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. sig { returns(T.nilable(Integer)) } attr_accessor :expires_after @@ -99,13 +99,13 @@ module Orb class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. sig { returns(T::Boolean) } attr_accessor :auto_collection # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. sig { returns(Integer) } attr_accessor :net_terms @@ -114,7 +114,7 @@ module Orb attr_accessor :memo # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi index ea1d478a..b8aa06f4 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi @@ -9,7 +9,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi index 761fbaad..f026fd78 100644 --- a/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +++ b/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi @@ -13,7 +13,7 @@ module Orb attr_accessor :amount # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. sig { returns(String) } attr_accessor :currency @@ -34,12 +34,12 @@ module Orb attr_accessor :per_unit_cost_basis # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. sig { returns(String) } attr_accessor :threshold # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. sig { returns(T.nilable(Integer)) } attr_accessor :expires_after @@ -89,13 +89,13 @@ module Orb class InvoiceSettings < Orb::Internal::Type::BaseModel # Whether the credits purchase invoice should auto collect with the customer's - # saved payment method. + # saved payment method. sig { returns(T::Boolean) } attr_accessor :auto_collection # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. sig { returns(Integer) } attr_accessor :net_terms @@ -104,7 +104,7 @@ module Orb attr_accessor :memo # If true, new credit blocks created by this top-up will require that the - # corresponding invoice is paid before they can be drawn down from. + # corresponding invoice is paid before they can be drawn down from. sig { returns(T.nilable(T::Boolean)) } attr_reader :require_successful_payment diff --git a/rbi/lib/orb/models/dimensional_price_group.rbi b/rbi/lib/orb/models/dimensional_price_group.rbi index 9a7c1f22..9ffc2a09 100644 --- a/rbi/lib/orb/models/dimensional_price_group.rbi +++ b/rbi/lib/orb/models/dimensional_price_group.rbi @@ -7,8 +7,8 @@ module Orb attr_accessor :id # The billable metric associated with this dimensional price group. All prices - # associated with this dimensional price group will be computed using this - # billable metric. + # associated with this dimensional price group will be computed using this + # billable metric. sig { returns(String) } attr_accessor :billable_metric_id @@ -21,9 +21,9 @@ module Orb attr_accessor :external_dimensional_price_group_id # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -32,8 +32,8 @@ module Orb attr_accessor :name # A dimensional price group is used to partition the result of a billable metric - # by a set of dimensions. Prices in a price group must specify the parition used - # to derive their usage. + # by a set of dimensions. Prices in a price group must specify the parition used + # to derive their usage. sig do params( id: String, diff --git a/rbi/lib/orb/models/dimensional_price_group_create_params.rbi b/rbi/lib/orb/models/dimensional_price_group_create_params.rbi index 9bbc836b..38ded0a4 100644 --- a/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +++ b/rbi/lib/orb/models/dimensional_price_group_create_params.rbi @@ -20,8 +20,8 @@ module Orb attr_accessor :external_dimensional_price_group_id # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/dimensional_price_group_list_params.rbi b/rbi/lib/orb/models/dimensional_price_group_list_params.rbi index c785bd6b..99e1de10 100644 --- a/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +++ b/rbi/lib/orb/models/dimensional_price_group_list_params.rbi @@ -7,7 +7,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/event_ingest_params.rbi b/rbi/lib/orb/models/event_ingest_params.rbi index 53cc61dd..f32c08f0 100644 --- a/rbi/lib/orb/models/event_ingest_params.rbi +++ b/rbi/lib/orb/models/event_ingest_params.rbi @@ -10,7 +10,7 @@ module Orb attr_accessor :events # If this ingestion request is part of a backfill, this parameter ties the - # ingested events to the backfill + # ingested events to the backfill sig { returns(T.nilable(String)) } attr_accessor :backfill_id @@ -51,19 +51,19 @@ module Orb attr_accessor :event_name # A unique value, generated by the client, that is used to de-duplicate events. - # Exactly one event with a given idempotency key will be ingested, which allows - # for safe request retries. + # Exactly one event with a given idempotency key will be ingested, which allows + # for safe request retries. sig { returns(String) } attr_accessor :idempotency_key # A dictionary of custom properties. Values in this dictionary must be numeric, - # boolean, or strings. Nested dictionaries are disallowed. + # boolean, or strings. Nested dictionaries are disallowed. sig { returns(T.anything) } attr_accessor :properties # An ISO 8601 format date with no timezone offset (i.e. UTC). This should - # represent the time that usage was recorded, and is particularly important to - # attribute usage to a given billing period. + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. sig { returns(Time) } attr_accessor :timestamp @@ -72,7 +72,7 @@ module Orb attr_accessor :customer_id # An alias for the Orb customer, whose mapping is specified when creating the - # customer + # customer sig { returns(T.nilable(String)) } attr_accessor :external_customer_id diff --git a/rbi/lib/orb/models/event_ingest_response.rbi b/rbi/lib/orb/models/event_ingest_response.rbi index 12ae1fb9..c1e84491 100644 --- a/rbi/lib/orb/models/event_ingest_response.rbi +++ b/rbi/lib/orb/models/event_ingest_response.rbi @@ -4,12 +4,12 @@ module Orb module Models class EventIngestResponse < Orb::Internal::Type::BaseModel # Contains all failing validation events. In the case of a 200, this array will - # always be empty. This field will always be present. + # always be empty. This field will always be present. sig { returns(T::Array[Orb::Models::EventIngestResponse::ValidationFailed]) } attr_accessor :validation_failed # Optional debug information (only present when debug=true is passed to the - # endpoint). Contains ingested and duplicate event idempotency keys. + # endpoint). Contains ingested and duplicate event idempotency keys. sig { returns(T.nilable(Orb::Models::EventIngestResponse::Debug)) } attr_reader :debug @@ -42,7 +42,7 @@ module Orb attr_accessor :idempotency_key # An array of strings corresponding to validation failures for this - # idempotency_key. + # idempotency_key. sig { returns(T::Array[String]) } attr_accessor :validation_errors @@ -61,7 +61,7 @@ module Orb attr_accessor :ingested # Optional debug information (only present when debug=true is passed to the - # endpoint). Contains ingested and duplicate event idempotency keys. + # endpoint). Contains ingested and duplicate event idempotency keys. sig { params(duplicate: T::Array[String], ingested: T::Array[String]).returns(T.attached_class) } def self.new(duplicate:, ingested:); end diff --git a/rbi/lib/orb/models/event_search_params.rbi b/rbi/lib/orb/models/event_search_params.rbi index 8f032ad8..43be508f 100644 --- a/rbi/lib/orb/models/event_search_params.rbi +++ b/rbi/lib/orb/models/event_search_params.rbi @@ -7,19 +7,19 @@ module Orb include Orb::Internal::Type::RequestParameters # This is an explicit array of IDs to filter by. Note that an event's ID is the - # idempotency_key that was originally used for ingestion, and this only supports - # events that have not been amended. Values in this array will be treated case - # sensitively. + # idempotency_key that was originally used for ingestion, and this only supports + # events that have not been amended. Values in this array will be treated case + # sensitively. sig { returns(T::Array[String]) } attr_accessor :event_ids # The end of the timeframe, exclusive, in which to search events. If not - # specified, the current time is used. + # specified, the current time is used. sig { returns(T.nilable(Time)) } attr_accessor :timeframe_end # The start of the timeframe, inclusive, in which to search events. If not - # specified, the one week ago is used. + # specified, the one week ago is used. sig { returns(T.nilable(Time)) } attr_accessor :timeframe_start diff --git a/rbi/lib/orb/models/event_search_response.rbi b/rbi/lib/orb/models/event_search_response.rbi index 1964ffdd..82e44551 100644 --- a/rbi/lib/orb/models/event_search_response.rbi +++ b/rbi/lib/orb/models/event_search_response.rbi @@ -17,8 +17,8 @@ module Orb class Data < Orb::Internal::Type::BaseModel # A unique value, generated by the client, that is used to de-duplicate events. - # Exactly one event with a given idempotency key will be ingested, which allows - # for safe request retries. + # Exactly one event with a given idempotency key will be ingested, which allows + # for safe request retries. sig { returns(String) } attr_accessor :id @@ -35,24 +35,24 @@ module Orb attr_accessor :event_name # An alias for the Orb customer, whose mapping is specified when creating the - # customer + # customer sig { returns(T.nilable(String)) } attr_accessor :external_customer_id # A dictionary of custom properties. Values in this dictionary must be numeric, - # boolean, or strings. Nested dictionaries are disallowed. + # boolean, or strings. Nested dictionaries are disallowed. sig { returns(T.anything) } attr_accessor :properties # An ISO 8601 format date with no timezone offset (i.e. UTC). This should - # represent the time that usage was recorded, and is particularly important to - # attribute usage to a given billing period. + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. sig { returns(Time) } attr_accessor :timestamp # The [Event](/core-concepts#event) resource represents a usage event that has - # been created for a customer. Events are the core of Orb's usage-based billing - # model, and are used to calculate the usage charges for a given billing period. + # been created for a customer. Events are the core of Orb's usage-based billing + # model, and are used to calculate the usage charges for a given billing period. sig do params( id: String, diff --git a/rbi/lib/orb/models/event_update_params.rbi b/rbi/lib/orb/models/event_update_params.rbi index 7483b6e1..f19d227a 100644 --- a/rbi/lib/orb/models/event_update_params.rbi +++ b/rbi/lib/orb/models/event_update_params.rbi @@ -11,13 +11,13 @@ module Orb attr_accessor :event_name # A dictionary of custom properties. Values in this dictionary must be numeric, - # boolean, or strings. Nested dictionaries are disallowed. + # boolean, or strings. Nested dictionaries are disallowed. sig { returns(T.anything) } attr_accessor :properties # An ISO 8601 format date with no timezone offset (i.e. UTC). This should - # represent the time that usage was recorded, and is particularly important to - # attribute usage to a given billing period. + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. sig { returns(Time) } attr_accessor :timestamp @@ -26,7 +26,7 @@ module Orb attr_accessor :customer_id # An alias for the Orb customer, whose mapping is specified when creating the - # customer + # customer sig { returns(T.nilable(String)) } attr_accessor :external_customer_id diff --git a/rbi/lib/orb/models/events/backfill_close_response.rbi b/rbi/lib/orb/models/events/backfill_close_response.rbi index ee975037..c5e587f1 100644 --- a/rbi/lib/orb/models/events/backfill_close_response.rbi +++ b/rbi/lib/orb/models/events/backfill_close_response.rbi @@ -8,7 +8,7 @@ module Orb attr_accessor :id # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. sig { returns(T.nilable(Time)) } attr_accessor :close_time @@ -16,7 +16,7 @@ module Orb attr_accessor :created_at # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. sig { returns(T.nilable(String)) } attr_accessor :customer_id @@ -25,8 +25,8 @@ module Orb attr_accessor :events_ingested # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. sig { returns(T::Boolean) } attr_accessor :replace_existing_events @@ -45,13 +45,13 @@ module Orb attr_accessor :timeframe_start # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate sig { returns(T.nilable(String)) } attr_accessor :deprecation_filter # A backfill represents an update to historical usage data, adding or replacing - # events in a timeframe. + # events in a timeframe. sig do params( id: String, diff --git a/rbi/lib/orb/models/events/backfill_create_params.rbi b/rbi/lib/orb/models/events/backfill_create_params.rbi index c8e8756a..c7d70673 100644 --- a/rbi/lib/orb/models/events/backfill_create_params.rbi +++ b/rbi/lib/orb/models/events/backfill_create_params.rbi @@ -8,41 +8,41 @@ module Orb include Orb::Internal::Type::RequestParameters # The (exclusive) end of the usage timeframe affected by this backfill. By - # default, Orb allows backfills up to 10 days in duration at a time. Reach out to - # discuss extending this limit and your use case. + # default, Orb allows backfills up to 10 days in duration at a time. Reach out to + # discuss extending this limit and your use case. sig { returns(Time) } attr_accessor :timeframe_end # The (inclusive) start of the usage timeframe affected by this backfill. By - # default, Orb allows backfills up to 10 days in duration at a time. Reach out to - # discuss extending this limit and your use case. + # default, Orb allows backfills up to 10 days in duration at a time. Reach out to + # discuss extending this limit and your use case. sig { returns(Time) } attr_accessor :timeframe_start # The time at which no more events will be accepted for this backfill. The - # backfill will automatically begin reflecting throughout Orb at the close time. - # If not specified, it will default to 1 day after the creation of the backfill. + # backfill will automatically begin reflecting throughout Orb at the close time. + # If not specified, it will default to 1 day after the creation of the backfill. sig { returns(T.nilable(Time)) } attr_accessor :close_time # The Orb-generated ID of the customer to which this backfill is scoped. Omitting - # this field will scope the backfill to all customers. + # this field will scope the backfill to all customers. sig { returns(T.nilable(String)) } attr_accessor :customer_id # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate sig { returns(T.nilable(String)) } attr_accessor :deprecation_filter # The external customer ID of the customer to which this backfill is scoped. - # Omitting this field will scope the backfill to all customers. + # Omitting this field will scope the backfill to all customers. sig { returns(T.nilable(String)) } attr_accessor :external_customer_id # If true, replaces all existing events in the timeframe with the newly ingested - # events. If false, adds the newly ingested events to the existing events. + # events. If false, adds the newly ingested events to the existing events. sig { returns(T.nilable(T::Boolean)) } attr_reader :replace_existing_events diff --git a/rbi/lib/orb/models/events/backfill_create_response.rbi b/rbi/lib/orb/models/events/backfill_create_response.rbi index dd00f98a..958af8f1 100644 --- a/rbi/lib/orb/models/events/backfill_create_response.rbi +++ b/rbi/lib/orb/models/events/backfill_create_response.rbi @@ -8,7 +8,7 @@ module Orb attr_accessor :id # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. sig { returns(T.nilable(Time)) } attr_accessor :close_time @@ -16,7 +16,7 @@ module Orb attr_accessor :created_at # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. sig { returns(T.nilable(String)) } attr_accessor :customer_id @@ -25,8 +25,8 @@ module Orb attr_accessor :events_ingested # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. sig { returns(T::Boolean) } attr_accessor :replace_existing_events @@ -45,13 +45,13 @@ module Orb attr_accessor :timeframe_start # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate sig { returns(T.nilable(String)) } attr_accessor :deprecation_filter # A backfill represents an update to historical usage data, adding or replacing - # events in a timeframe. + # events in a timeframe. sig do params( id: String, diff --git a/rbi/lib/orb/models/events/backfill_fetch_response.rbi b/rbi/lib/orb/models/events/backfill_fetch_response.rbi index 04dd3bde..0a18ce81 100644 --- a/rbi/lib/orb/models/events/backfill_fetch_response.rbi +++ b/rbi/lib/orb/models/events/backfill_fetch_response.rbi @@ -8,7 +8,7 @@ module Orb attr_accessor :id # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. sig { returns(T.nilable(Time)) } attr_accessor :close_time @@ -16,7 +16,7 @@ module Orb attr_accessor :created_at # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. sig { returns(T.nilable(String)) } attr_accessor :customer_id @@ -25,8 +25,8 @@ module Orb attr_accessor :events_ingested # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. sig { returns(T::Boolean) } attr_accessor :replace_existing_events @@ -45,13 +45,13 @@ module Orb attr_accessor :timeframe_start # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate sig { returns(T.nilable(String)) } attr_accessor :deprecation_filter # A backfill represents an update to historical usage data, adding or replacing - # events in a timeframe. + # events in a timeframe. sig do params( id: String, diff --git a/rbi/lib/orb/models/events/backfill_list_params.rbi b/rbi/lib/orb/models/events/backfill_list_params.rbi index ebde71a4..bb252b75 100644 --- a/rbi/lib/orb/models/events/backfill_list_params.rbi +++ b/rbi/lib/orb/models/events/backfill_list_params.rbi @@ -8,7 +8,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/events/backfill_list_response.rbi b/rbi/lib/orb/models/events/backfill_list_response.rbi index 569ca45e..bfc3cea9 100644 --- a/rbi/lib/orb/models/events/backfill_list_response.rbi +++ b/rbi/lib/orb/models/events/backfill_list_response.rbi @@ -8,7 +8,7 @@ module Orb attr_accessor :id # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. sig { returns(T.nilable(Time)) } attr_accessor :close_time @@ -16,7 +16,7 @@ module Orb attr_accessor :created_at # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. sig { returns(T.nilable(String)) } attr_accessor :customer_id @@ -25,8 +25,8 @@ module Orb attr_accessor :events_ingested # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. sig { returns(T::Boolean) } attr_accessor :replace_existing_events @@ -45,13 +45,13 @@ module Orb attr_accessor :timeframe_start # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate sig { returns(T.nilable(String)) } attr_accessor :deprecation_filter # A backfill represents an update to historical usage data, adding or replacing - # events in a timeframe. + # events in a timeframe. sig do params( id: String, diff --git a/rbi/lib/orb/models/events/backfill_revert_response.rbi b/rbi/lib/orb/models/events/backfill_revert_response.rbi index d85a97bc..0147cdd7 100644 --- a/rbi/lib/orb/models/events/backfill_revert_response.rbi +++ b/rbi/lib/orb/models/events/backfill_revert_response.rbi @@ -8,7 +8,7 @@ module Orb attr_accessor :id # If in the future, the time at which the backfill will automatically close. If in - # the past, the time at which the backfill was closed. + # the past, the time at which the backfill was closed. sig { returns(T.nilable(Time)) } attr_accessor :close_time @@ -16,7 +16,7 @@ module Orb attr_accessor :created_at # The Orb-generated ID of the customer to which this backfill is scoped. If - # `null`, this backfill is scoped to all customers. + # `null`, this backfill is scoped to all customers. sig { returns(T.nilable(String)) } attr_accessor :customer_id @@ -25,8 +25,8 @@ module Orb attr_accessor :events_ingested # If `true`, existing events in the backfill's timeframe will be replaced with the - # newly ingested events associated with the backfill. If `false`, newly ingested - # events will be added to the existing events. + # newly ingested events associated with the backfill. If `false`, newly ingested + # events will be added to the existing events. sig { returns(T::Boolean) } attr_accessor :replace_existing_events @@ -45,13 +45,13 @@ module Orb attr_accessor :timeframe_start # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate sig { returns(T.nilable(String)) } attr_accessor :deprecation_filter # A backfill represents an update to historical usage data, adding or replacing - # events in a timeframe. + # events in a timeframe. sig do params( id: String, diff --git a/rbi/lib/orb/models/events/event_volumes.rbi b/rbi/lib/orb/models/events/event_volumes.rbi index 3e39437c..fda18975 100644 --- a/rbi/lib/orb/models/events/event_volumes.rbi +++ b/rbi/lib/orb/models/events/event_volumes.rbi @@ -28,7 +28,7 @@ module Orb attr_accessor :timeframe_start # An EventVolume contains the event volume ingested in an hourly window. The - # timestamp used for the aggregation is the `timestamp` datetime field on events. + # timestamp used for the aggregation is the `timestamp` datetime field on events. sig { params(count: Integer, timeframe_end: Time, timeframe_start: Time).returns(T.attached_class) } def self.new(count:, timeframe_end:, timeframe_start:); end diff --git a/rbi/lib/orb/models/events/volume_list_params.rbi b/rbi/lib/orb/models/events/volume_list_params.rbi index 78287890..068a8848 100644 --- a/rbi/lib/orb/models/events/volume_list_params.rbi +++ b/rbi/lib/orb/models/events/volume_list_params.rbi @@ -8,14 +8,14 @@ module Orb include Orb::Internal::Type::RequestParameters # The start of the timeframe, inclusive, in which to return event volume. All - # datetime values are converted to UTC time. If the specified time isn't - # hour-aligned, the response includes the event volume count for the hour the time - # falls in. + # datetime values are converted to UTC time. If the specified time isn't + # hour-aligned, the response includes the event volume count for the hour the time + # falls in. sig { returns(Time) } attr_accessor :timeframe_start # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor @@ -27,9 +27,9 @@ module Orb attr_writer :limit # The end of the timeframe, exclusive, in which to return event volume. If not - # specified, the current time is used. All datetime values are converted to UTC - # time.If the specified time isn't hour-aligned, the response includes the event - # volumecount for the hour the time falls in. + # specified, the current time is used. All datetime values are converted to UTC + # time.If the specified time isn't hour-aligned, the response includes the event + # volumecount for the hour the time falls in. sig { returns(T.nilable(Time)) } attr_reader :timeframe_end diff --git a/rbi/lib/orb/models/invoice.rbi b/rbi/lib/orb/models/invoice.rbi index baaf8166..17e01352 100644 --- a/rbi/lib/orb/models/invoice.rbi +++ b/rbi/lib/orb/models/invoice.rbi @@ -7,7 +7,7 @@ module Orb attr_accessor :id # This is the final amount required to be charged to the customer and reflects the - # application of the customer balance to the `total` of the invoice. + # application of the customer balance to the `total` of the invoice. sig { returns(String) } attr_accessor :amount_due @@ -48,110 +48,110 @@ module Orb attr_accessor :customer_balance_transactions # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig { returns(T.nilable(Orb::Models::Invoice::CustomerTaxID)) } attr_reader :customer_tax_id @@ -161,8 +161,8 @@ module Orb attr_writer :customer_tax_id # This field is deprecated in favor of `discounts`. If a `discounts` list is - # provided, the first discount in the list will be returned. If the list is empty, - # `None` will be returned. + # provided, the first discount in the list will be returned. If the list is empty, + # `None` will be returned. sig { returns(T.anything) } attr_accessor :discount @@ -174,18 +174,18 @@ module Orb attr_accessor :discounts # When the invoice payment is due. The due date is null if the invoice is not yet - # finalized. + # finalized. sig { returns(T.nilable(Time)) } attr_accessor :due_date # If the invoice has a status of `draft`, this will be the time that the invoice - # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is - # true, the invoice will automatically begin issuing at this time. + # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is + # true, the invoice will automatically begin issuing at this time. sig { returns(T.nilable(Time)) } attr_accessor :eligible_to_issue_at # A URL for the customer-facing invoice portal. This URL expires 30 days after the - # invoice's due date, or 60 days after being re-generated through the UI. + # invoice's due date, or 60 days after being re-generated through the UI. sig { returns(T.nilable(String)) } attr_accessor :hosted_invoice_url @@ -194,8 +194,8 @@ module Orb attr_accessor :invoice_date # Automatically generated invoice number to help track and reconcile invoices. - # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per - # account or customer. + # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per + # account or customer. sig { returns(String) } attr_accessor :invoice_number @@ -207,12 +207,12 @@ module Orb attr_accessor :invoice_source # If the invoice failed to issue, this will be the last time it failed to issue - # (even if it is now in a different state.) + # (even if it is now in a different state.) sig { returns(T.nilable(Time)) } attr_accessor :issue_failed_at # If the invoice has been issued, this will be the time it transitioned to - # `issued` (even if it is now in a different state.) + # `issued` (even if it is now in a different state.) sig { returns(T.nilable(Time)) } attr_accessor :issued_at @@ -234,9 +234,9 @@ module Orb attr_accessor :memo # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -250,7 +250,7 @@ module Orb attr_accessor :minimum_amount # If the invoice has a status of `paid`, this gives a timestamp when the invoice - # was paid. + # was paid. sig { returns(T.nilable(Time)) } attr_accessor :paid_at @@ -259,18 +259,18 @@ module Orb attr_accessor :payment_attempts # If payment was attempted on this invoice but failed, this will be the time of - # the most recent attempt. + # the most recent attempt. sig { returns(T.nilable(Time)) } attr_accessor :payment_failed_at # If payment was attempted on this invoice, this will be the start time of the - # most recent attempt. This field is especially useful for delayed-notification - # payment mechanisms (like bank transfers), where payment can take 3 days or more. + # most recent attempt. This field is especially useful for delayed-notification + # payment mechanisms (like bank transfers), where payment can take 3 days or more. sig { returns(T.nilable(Time)) } attr_accessor :payment_started_at # If the invoice is in draft, this timestamp will reflect when the invoice is - # scheduled to be issued. + # scheduled to be issued. sig { returns(T.nilable(Time)) } attr_accessor :scheduled_issue_at @@ -297,8 +297,8 @@ module Orb attr_accessor :subtotal # If the invoice failed to sync, this will be the last time an external invoicing - # provider sync was attempted. This field will always be `null` for invoices using - # Orb Invoicing. + # provider sync was attempted. This field will always be `null` for invoices using + # Orb Invoicing. sig { returns(T.nilable(Time)) } attr_accessor :sync_failed_at @@ -307,20 +307,20 @@ module Orb attr_accessor :total # If the invoice has a status of `void`, this gives a timestamp when the invoice - # was voided. + # was voided. sig { returns(T.nilable(Time)) } attr_accessor :voided_at # This is true if the invoice will be automatically issued in the future, and - # false otherwise. + # false otherwise. sig { returns(T::Boolean) } attr_accessor :will_auto_issue # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, - # representing the request for payment for a single subscription. This includes a - # set of line items, which correspond to prices in the subscription's plan and can - # represent fixed recurring fees or usage-based fees. They are generated at the - # end of a billing period, or as the result of an action, such as a cancellation. + # representing the request for payment for a single subscription. This includes a + # set of line items, which correspond to prices in the subscription's plan and can + # represent fixed recurring fees or usage-based fees. They are generated at the + # end of a billing period, or as the result of an action, such as a cancellation. sig do params( id: String, @@ -473,8 +473,8 @@ module Orb attr_accessor :enabled # If the invoice is scheduled for auto-collection, this field will reflect when - # the next attempt will occur. If dunning has been exhausted, or auto-collection - # is not enabled for this invoice, this field will be `null`. + # the next attempt will occur. If dunning has been exhausted, or auto-collection + # is not enabled for this invoice, this field will be `null`. sig { returns(T.nilable(Time)) } attr_accessor :next_attempt_at @@ -483,11 +483,11 @@ module Orb attr_accessor :num_attempts # If Orb has ever attempted payment auto-collection for this invoice, this field - # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, - # this can be used to tell whether the invoice is currently in dunning (that is, - # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or - # if dunning has been exhausted (`previously_attempted_at` is non-null, but - # `next_attempt_time` is null). + # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, + # this can be used to tell whether the invoice is currently in dunning (that is, + # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or + # if dunning has been exhausted (`previously_attempted_at` is non-null, but + # `next_attempt_time` is null). sig { returns(T.nilable(Time)) } attr_accessor :previously_attempted_at @@ -585,7 +585,7 @@ module Orb attr_accessor :type # If the credit note has a status of `void`, this gives a timestamp when the - # credit note was voided. + # credit note was voided. sig { returns(T.nilable(Time)) } attr_accessor :voided_at @@ -666,7 +666,7 @@ module Orb attr_accessor :description # The new value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. sig { returns(String) } attr_accessor :ending_balance @@ -682,7 +682,7 @@ module Orb attr_writer :invoice # The original value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. sig { returns(String) } attr_accessor :starting_balance @@ -815,110 +815,110 @@ module Orb attr_accessor :value # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig do params( country: Orb::Models::Invoice::CustomerTaxID::Country::OrSymbol, @@ -1135,13 +1135,13 @@ module Orb attr_accessor :id # The line amount after any adjustments and before overage conversion, credits and - # partial invoicing. + # partial invoicing. sig { returns(String) } attr_accessor :adjusted_subtotal # All adjustments applied to the line item in the order they were applied based on - # invoice calculations (ie. usage discounts -> amount discounts -> percentage - # discounts -> minimums -> maximums). + # invoice calculations (ie. usage discounts -> amount discounts -> percentage + # discounts -> minimums -> maximums). sig do returns( T::Array[ @@ -1158,7 +1158,7 @@ module Orb attr_accessor :adjustments # The final amount for a line item after all adjustments and pre paid credits have - # been applied. + # been applied. sig { returns(String) } attr_accessor :amount @@ -1189,8 +1189,8 @@ module Orb attr_accessor :filter # [DEPRECATED] For configured prices that are split by a grouping key, this will - # be populated with the key and a value. The `amount` and `subtotal` will be the - # values for this particular grouping. + # be populated with the key and a value. The `amount` and `subtotal` will be the + # values for this particular grouping. sig { returns(T.nilable(String)) } attr_accessor :grouping @@ -1225,15 +1225,15 @@ module Orb attr_accessor :partially_invoiced_amount # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.nilable( @@ -1281,7 +1281,7 @@ module Orb attr_accessor :start_date # For complex pricing structures, the line item can be broken down further in - # `sub_line_items`. + # `sub_line_items`. sig do returns( T::Array[ @@ -1300,7 +1300,7 @@ module Orb attr_accessor :subtotal # An array of tax rates and their incurred tax amounts. Empty if no tax - # integration is configured. + # integration is configured. sig { returns(T::Array[Orb::Models::Invoice::LineItem::TaxAmount]) } attr_accessor :tax_amounts @@ -1517,7 +1517,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -1526,7 +1526,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -1580,7 +1580,7 @@ module Orb attr_accessor :amount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -1589,7 +1589,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -1651,12 +1651,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -1718,7 +1718,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -1727,7 +1727,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1792,12 +1792,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1854,7 +1854,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -1874,7 +1874,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -2218,7 +2218,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -2237,7 +2237,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids diff --git a/rbi/lib/orb/models/invoice_create_params.rbi b/rbi/lib/orb/models/invoice_create_params.rbi index 1cd58e8e..3d70953b 100644 --- a/rbi/lib/orb/models/invoice_create_params.rbi +++ b/rbi/lib/orb/models/invoice_create_params.rbi @@ -7,12 +7,12 @@ module Orb include Orb::Internal::Type::RequestParameters # An ISO 4217 currency string. Must be the same as the customer's currency if it - # is set. + # is set. sig { returns(String) } attr_accessor :currency # Optional invoice date to set. Must be in the past, if not set, `invoice_date` is - # set to the current time in the customer's timezone. + # set to the current time in the customer's timezone. sig { returns(Time) } attr_accessor :invoice_date @@ -20,14 +20,14 @@ module Orb attr_accessor :line_items # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of '0' here represents that the - # invoice is due on issue, whereas a value of 30 represents that the customer has - # 30 days to pay the invoice. + # invoices as the date that they are due. A value of '0' here represents that the + # invoice is due on issue, whereas a value of 30 represents that the customer has + # 30 days to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The id of the `Customer` to create this invoice for. One of `customer_id` and - # `external_customer_id` are required. + # `external_customer_id` are required. sig { returns(T.nilable(String)) } attr_accessor :customer_id @@ -47,7 +47,7 @@ module Orb attr_accessor :discount # The `external_customer_id` of the `Customer` to create this invoice for. One of - # `customer_id` and `external_customer_id` are required. + # `customer_id` and `external_customer_id` are required. sig { returns(T.nilable(String)) } attr_accessor :external_customer_id @@ -56,13 +56,13 @@ module Orb attr_accessor :memo # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # When true, this invoice will automatically be issued upon creation. When false, - # the resulting invoice will require manual review to issue. Defaulted to false. + # the resulting invoice will require manual review to issue. Defaulted to false. sig { returns(T.nilable(T::Boolean)) } attr_reader :will_auto_issue diff --git a/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi b/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi index 2b3d0bd0..ec3924d8 100644 --- a/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +++ b/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi @@ -7,7 +7,7 @@ module Orb attr_accessor :id # This is the final amount required to be charged to the customer and reflects the - # application of the customer balance to the `total` of the invoice. + # application of the customer balance to the `total` of the invoice. sig { returns(String) } attr_accessor :amount_due @@ -55,110 +55,110 @@ module Orb attr_accessor :customer_balance_transactions # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig { returns(T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID)) } attr_reader :customer_tax_id @@ -171,8 +171,8 @@ module Orb attr_writer :customer_tax_id # This field is deprecated in favor of `discounts`. If a `discounts` list is - # provided, the first discount in the list will be returned. If the list is empty, - # `None` will be returned. + # provided, the first discount in the list will be returned. If the list is empty, + # `None` will be returned. sig { returns(T.anything) } attr_accessor :discount @@ -184,24 +184,24 @@ module Orb attr_accessor :discounts # When the invoice payment is due. The due date is null if the invoice is not yet - # finalized. + # finalized. sig { returns(T.nilable(Time)) } attr_accessor :due_date # If the invoice has a status of `draft`, this will be the time that the invoice - # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is - # true, the invoice will automatically begin issuing at this time. + # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is + # true, the invoice will automatically begin issuing at this time. sig { returns(T.nilable(Time)) } attr_accessor :eligible_to_issue_at # A URL for the customer-facing invoice portal. This URL expires 30 days after the - # invoice's due date, or 60 days after being re-generated through the UI. + # invoice's due date, or 60 days after being re-generated through the UI. sig { returns(T.nilable(String)) } attr_accessor :hosted_invoice_url # Automatically generated invoice number to help track and reconcile invoices. - # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per - # account or customer. + # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per + # account or customer. sig { returns(String) } attr_accessor :invoice_number @@ -213,12 +213,12 @@ module Orb attr_accessor :invoice_source # If the invoice failed to issue, this will be the last time it failed to issue - # (even if it is now in a different state.) + # (even if it is now in a different state.) sig { returns(T.nilable(Time)) } attr_accessor :issue_failed_at # If the invoice has been issued, this will be the time it transitioned to - # `issued` (even if it is now in a different state.) + # `issued` (even if it is now in a different state.) sig { returns(T.nilable(Time)) } attr_accessor :issued_at @@ -245,9 +245,9 @@ module Orb attr_accessor :memo # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -266,7 +266,7 @@ module Orb attr_accessor :minimum_amount # If the invoice has a status of `paid`, this gives a timestamp when the invoice - # was paid. + # was paid. sig { returns(T.nilable(Time)) } attr_accessor :paid_at @@ -275,18 +275,18 @@ module Orb attr_accessor :payment_attempts # If payment was attempted on this invoice but failed, this will be the time of - # the most recent attempt. + # the most recent attempt. sig { returns(T.nilable(Time)) } attr_accessor :payment_failed_at # If payment was attempted on this invoice, this will be the start time of the - # most recent attempt. This field is especially useful for delayed-notification - # payment mechanisms (like bank transfers), where payment can take 3 days or more. + # most recent attempt. This field is especially useful for delayed-notification + # payment mechanisms (like bank transfers), where payment can take 3 days or more. sig { returns(T.nilable(Time)) } attr_accessor :payment_started_at # If the invoice is in draft, this timestamp will reflect when the invoice is - # scheduled to be issued. + # scheduled to be issued. sig { returns(T.nilable(Time)) } attr_accessor :scheduled_issue_at @@ -320,8 +320,8 @@ module Orb attr_accessor :subtotal # If the invoice failed to sync, this will be the last time an external invoicing - # provider sync was attempted. This field will always be `null` for invoices using - # Orb Invoicing. + # provider sync was attempted. This field will always be `null` for invoices using + # Orb Invoicing. sig { returns(T.nilable(Time)) } attr_accessor :sync_failed_at @@ -334,12 +334,12 @@ module Orb attr_accessor :total # If the invoice has a status of `void`, this gives a timestamp when the invoice - # was voided. + # was voided. sig { returns(T.nilable(Time)) } attr_accessor :voided_at # This is true if the invoice will be automatically issued in the future, and - # false otherwise. + # false otherwise. sig { returns(T::Boolean) } attr_accessor :will_auto_issue @@ -495,8 +495,8 @@ module Orb attr_accessor :enabled # If the invoice is scheduled for auto-collection, this field will reflect when - # the next attempt will occur. If dunning has been exhausted, or auto-collection - # is not enabled for this invoice, this field will be `null`. + # the next attempt will occur. If dunning has been exhausted, or auto-collection + # is not enabled for this invoice, this field will be `null`. sig { returns(T.nilable(Time)) } attr_accessor :next_attempt_at @@ -505,11 +505,11 @@ module Orb attr_accessor :num_attempts # If Orb has ever attempted payment auto-collection for this invoice, this field - # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, - # this can be used to tell whether the invoice is currently in dunning (that is, - # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or - # if dunning has been exhausted (`previously_attempted_at` is non-null, but - # `next_attempt_time` is null). + # will reflect when that attempt occurred. In conjunction with `next_attempt_at`, + # this can be used to tell whether the invoice is currently in dunning (that is, + # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or + # if dunning has been exhausted (`previously_attempted_at` is non-null, but + # `next_attempt_time` is null). sig { returns(T.nilable(Time)) } attr_accessor :previously_attempted_at @@ -607,7 +607,7 @@ module Orb attr_accessor :type # If the credit note has a status of `void`, this gives a timestamp when the - # credit note was voided. + # credit note was voided. sig { returns(T.nilable(Time)) } attr_accessor :voided_at @@ -693,7 +693,7 @@ module Orb attr_accessor :description # The new value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. sig { returns(String) } attr_accessor :ending_balance @@ -714,7 +714,7 @@ module Orb attr_writer :invoice # The original value of the customer's balance prior to the transaction, in the - # customer's currency. + # customer's currency. sig { returns(String) } attr_accessor :starting_balance @@ -916,110 +916,110 @@ module Orb attr_accessor :value # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | sig do params( country: Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::OrSymbol, @@ -1247,13 +1247,13 @@ module Orb attr_accessor :id # The line amount after any adjustments and before overage conversion, credits and - # partial invoicing. + # partial invoicing. sig { returns(String) } attr_accessor :adjusted_subtotal # All adjustments applied to the line item in the order they were applied based on - # invoice calculations (ie. usage discounts -> amount discounts -> percentage - # discounts -> minimums -> maximums). + # invoice calculations (ie. usage discounts -> amount discounts -> percentage + # discounts -> minimums -> maximums). sig do returns( T::Array[ @@ -1270,7 +1270,7 @@ module Orb attr_accessor :adjustments # The final amount for a line item after all adjustments and pre paid credits have - # been applied. + # been applied. sig { returns(String) } attr_accessor :amount @@ -1301,8 +1301,8 @@ module Orb attr_accessor :filter # [DEPRECATED] For configured prices that are split by a grouping key, this will - # be populated with the key and a value. The `amount` and `subtotal` will be the - # values for this particular grouping. + # be populated with the key and a value. The `amount` and `subtotal` will be the + # values for this particular grouping. sig { returns(T.nilable(String)) } attr_accessor :grouping @@ -1347,15 +1347,15 @@ module Orb attr_accessor :partially_invoiced_amount # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.nilable( @@ -1403,7 +1403,7 @@ module Orb attr_accessor :start_date # For complex pricing structures, the line item can be broken down further in - # `sub_line_items`. + # `sub_line_items`. sig do returns( T::Array[ @@ -1422,7 +1422,7 @@ module Orb attr_accessor :subtotal # An array of tax rates and their incurred tax amounts. Empty if no tax - # integration is configured. + # integration is configured. sig { returns(T::Array[Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount]) } attr_accessor :tax_amounts @@ -1639,7 +1639,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -1648,7 +1648,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -1702,7 +1702,7 @@ module Orb attr_accessor :amount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -1711,7 +1711,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -1773,12 +1773,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -1840,7 +1840,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -1849,7 +1849,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1914,12 +1914,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1976,7 +1976,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -1996,7 +1996,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -2376,7 +2376,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -2395,7 +2395,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids diff --git a/rbi/lib/orb/models/invoice_issue_params.rbi b/rbi/lib/orb/models/invoice_issue_params.rbi index 31558a19..9e113657 100644 --- a/rbi/lib/orb/models/invoice_issue_params.rbi +++ b/rbi/lib/orb/models/invoice_issue_params.rbi @@ -7,10 +7,10 @@ module Orb include Orb::Internal::Type::RequestParameters # If true, the invoice will be issued synchronously. If false, the invoice will be - # issued asynchronously. The synchronous option is only available for invoices - # that have no usage fees. If the invoice is configured to sync to an external - # provider, a successful response from this endpoint guarantees the invoice is - # present in the provider. + # issued asynchronously. The synchronous option is only available for invoices + # that have no usage fees. If the invoice is configured to sync to an external + # provider, a successful response from this endpoint guarantees the invoice is + # present in the provider. sig { returns(T.nilable(T::Boolean)) } attr_reader :synchronous diff --git a/rbi/lib/orb/models/invoice_line_item_create_params.rbi b/rbi/lib/orb/models/invoice_line_item_create_params.rbi index 1e0ed8f0..dce846e9 100644 --- a/rbi/lib/orb/models/invoice_line_item_create_params.rbi +++ b/rbi/lib/orb/models/invoice_line_item_create_params.rbi @@ -19,7 +19,7 @@ module Orb attr_accessor :invoice_id # The item name associated with this line item. If an item with the same name - # exists in Orb, that item will be associated with the line item. + # exists in Orb, that item will be associated with the line item. sig { returns(String) } attr_accessor :name diff --git a/rbi/lib/orb/models/invoice_line_item_create_response.rbi b/rbi/lib/orb/models/invoice_line_item_create_response.rbi index bf2790fa..770bfc72 100644 --- a/rbi/lib/orb/models/invoice_line_item_create_response.rbi +++ b/rbi/lib/orb/models/invoice_line_item_create_response.rbi @@ -8,13 +8,13 @@ module Orb attr_accessor :id # The line amount after any adjustments and before overage conversion, credits and - # partial invoicing. + # partial invoicing. sig { returns(String) } attr_accessor :adjusted_subtotal # All adjustments applied to the line item in the order they were applied based on - # invoice calculations (ie. usage discounts -> amount discounts -> percentage - # discounts -> minimums -> maximums). + # invoice calculations (ie. usage discounts -> amount discounts -> percentage + # discounts -> minimums -> maximums). sig do returns( T::Array[ @@ -31,7 +31,7 @@ module Orb attr_accessor :adjustments # The final amount for a line item after all adjustments and pre paid credits have - # been applied. + # been applied. sig { returns(String) } attr_accessor :amount @@ -62,8 +62,8 @@ module Orb attr_accessor :filter # [DEPRECATED] For configured prices that are split by a grouping key, this will - # be populated with the key and a value. The `amount` and `subtotal` will be the - # values for this particular grouping. + # be populated with the key and a value. The `amount` and `subtotal` will be the + # values for this particular grouping. sig { returns(T.nilable(String)) } attr_accessor :grouping @@ -108,15 +108,15 @@ module Orb attr_accessor :partially_invoiced_amount # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.nilable( @@ -164,7 +164,7 @@ module Orb attr_accessor :start_date # For complex pricing structures, the line item can be broken down further in - # `sub_line_items`. + # `sub_line_items`. sig do returns( T::Array[ @@ -183,7 +183,7 @@ module Orb attr_accessor :subtotal # An array of tax rates and their incurred tax amounts. Empty if no tax - # integration is configured. + # integration is configured. sig { returns(T::Array[Orb::Models::InvoiceLineItemCreateResponse::TaxAmount]) } attr_accessor :tax_amounts @@ -400,7 +400,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -409,7 +409,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -463,7 +463,7 @@ module Orb attr_accessor :amount # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -472,7 +472,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -534,12 +534,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -601,7 +601,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -610,7 +610,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -675,12 +675,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -737,7 +737,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -757,7 +757,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids diff --git a/rbi/lib/orb/models/invoice_list_params.rbi b/rbi/lib/orb/models/invoice_list_params.rbi index 1e6c59aa..843d1d0c 100644 --- a/rbi/lib/orb/models/invoice_list_params.rbi +++ b/rbi/lib/orb/models/invoice_list_params.rbi @@ -16,7 +16,7 @@ module Orb attr_accessor :amount_lt # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor @@ -30,9 +30,9 @@ module Orb attr_accessor :due_date # Filters invoices by their due dates within a specific time range in the past. - # Specify the range as a number followed by 'd' (days) or 'm' (months). For - # example, '7d' filters invoices due in the last 7 days, and '2m' filters those - # due in the last 2 months. + # Specify the range as a number followed by 'd' (days) or 'm' (months). For + # example, '7d' filters invoices due in the last 7 days, and '2m' filters those + # due in the last 2 months. sig { returns(T.nilable(String)) } attr_accessor :due_date_window diff --git a/rbi/lib/orb/models/invoice_update_params.rbi b/rbi/lib/orb/models/invoice_update_params.rbi index 5b006f69..b14cca36 100644 --- a/rbi/lib/orb/models/invoice_update_params.rbi +++ b/rbi/lib/orb/models/invoice_update_params.rbi @@ -7,8 +7,8 @@ module Orb include Orb::Internal::Type::RequestParameters # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/item.rbi b/rbi/lib/orb/models/item.rbi index 4bd0d91f..a245f107 100644 --- a/rbi/lib/orb/models/item.rbi +++ b/rbi/lib/orb/models/item.rbi @@ -16,8 +16,8 @@ module Orb attr_accessor :name # The Item resource represents a sellable product or good. Items are associated - # with all line items, billable metrics, and prices and are used for defining - # external sync behavior for invoices and tax calculation purposes. + # with all line items, billable metrics, and prices and are used for defining + # external sync behavior for invoices and tax calculation purposes. sig do params( id: String, diff --git a/rbi/lib/orb/models/item_list_params.rbi b/rbi/lib/orb/models/item_list_params.rbi index 4c6a667f..72042447 100644 --- a/rbi/lib/orb/models/item_list_params.rbi +++ b/rbi/lib/orb/models/item_list_params.rbi @@ -7,7 +7,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/metric_create_params.rbi b/rbi/lib/orb/models/metric_create_params.rbi index 8e3cdf50..b8fb5180 100644 --- a/rbi/lib/orb/models/metric_create_params.rbi +++ b/rbi/lib/orb/models/metric_create_params.rbi @@ -23,8 +23,8 @@ module Orb attr_accessor :sql # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/metric_list_params.rbi b/rbi/lib/orb/models/metric_list_params.rbi index 31dd02f1..fe639eed 100644 --- a/rbi/lib/orb/models/metric_list_params.rbi +++ b/rbi/lib/orb/models/metric_list_params.rbi @@ -19,7 +19,7 @@ module Orb attr_accessor :created_at_lte # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/metric_update_params.rbi b/rbi/lib/orb/models/metric_update_params.rbi index ecea21a4..aeb30a6e 100644 --- a/rbi/lib/orb/models/metric_update_params.rbi +++ b/rbi/lib/orb/models/metric_update_params.rbi @@ -7,8 +7,8 @@ module Orb include Orb::Internal::Type::RequestParameters # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/percentage_discount.rbi b/rbi/lib/orb/models/percentage_discount.rbi index 46938aa4..d7440f9c 100644 --- a/rbi/lib/orb/models/percentage_discount.rbi +++ b/rbi/lib/orb/models/percentage_discount.rbi @@ -4,7 +4,7 @@ module Orb module Models class PercentageDiscount < Orb::Internal::Type::BaseModel # List of price_ids that this discount applies to. For plan/plan phase discounts, - # this can be a subset of prices. + # this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -12,7 +12,7 @@ module Orb attr_accessor :discount_type # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount diff --git a/rbi/lib/orb/models/plan.rbi b/rbi/lib/orb/models/plan.rbi index f297bf6d..a03c051b 100644 --- a/rbi/lib/orb/models/plan.rbi +++ b/rbi/lib/orb/models/plan.rbi @@ -7,7 +7,7 @@ module Orb attr_accessor :id # Adjustments for this plan. If the plan has phases, this includes adjustments - # across all phases of the plan. + # across all phases of the plan. sig do returns( T::Array[ @@ -30,7 +30,7 @@ module Orb attr_writer :base_plan # The parent plan id if the given plan was created by overriding one or more of - # the parent's prices + # the parent's prices sig { returns(T.nilable(String)) } attr_accessor :base_plan_id @@ -38,12 +38,12 @@ module Orb attr_accessor :created_at # An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's - # prices. + # prices. sig { returns(String) } attr_accessor :currency # The default memo text on the invoices corresponding to subscriptions on this - # plan. Note that each subscription may configure its own memo. + # plan. Note that each subscription may configure its own memo. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -65,13 +65,13 @@ module Orb attr_accessor :discount # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. sig { returns(T.nilable(String)) } attr_accessor :external_plan_id # An ISO 4217 currency string for which this plan is billed in. Matches `currency` - # unless `currency` is a custom pricing unit. + # unless `currency` is a custom pricing unit. sig { returns(String) } attr_accessor :invoicing_currency @@ -85,9 +85,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -104,10 +104,10 @@ module Orb attr_accessor :name # Determines the difference between the invoice issue date and the due date. A - # value of "0" here signifies that invoices are due on issue, whereas a value of - # "30" means that the customer has a month to pay the invoice before its overdue. - # Note that individual subscriptions or invoices may set a different net terms - # configuration. + # value of "0" here signifies that invoices are due on issue, whereas a value of + # "30" means that the customer has a month to pay the invoice before its overdue. + # Note that individual subscriptions or invoices may set a different net terms + # configuration. sig { returns(T.nilable(Integer)) } attr_accessor :net_terms @@ -115,7 +115,7 @@ module Orb attr_accessor :plan_phases # Prices for this plan. If the plan has phases, this includes prices across all - # phases of the plan. + # phases of the plan. sig do returns( T::Array[ @@ -173,9 +173,9 @@ module Orb attr_accessor :version # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig do params( id: String, @@ -374,7 +374,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -387,7 +387,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -437,7 +437,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -446,7 +446,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -508,12 +508,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -575,7 +575,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -584,7 +584,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -649,12 +649,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -718,8 +718,8 @@ module Orb attr_accessor :id # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. sig { returns(T.nilable(String)) } attr_accessor :external_plan_id @@ -746,7 +746,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -765,7 +765,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -804,7 +804,7 @@ module Orb attr_accessor :discount # How many terms of length `duration_unit` this phase is active for. If null, this - # phase is evergreen and active indefinitely + # phase is evergreen and active indefinitely sig { returns(T.nilable(Integer)) } attr_accessor :duration @@ -919,7 +919,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -938,7 +938,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids diff --git a/rbi/lib/orb/models/plan_create_params.rbi b/rbi/lib/orb/models/plan_create_params.rbi index 8be66bf5..7dadd398 100644 --- a/rbi/lib/orb/models/plan_create_params.rbi +++ b/rbi/lib/orb/models/plan_create_params.rbi @@ -7,7 +7,7 @@ module Orb include Orb::Internal::Type::RequestParameters # An ISO 4217 currency string for invoices generated by subscriptions on this - # plan. + # plan. sig { returns(String) } attr_accessor :currency @@ -15,7 +15,7 @@ module Orb attr_accessor :name # Prices for this plan. If the plan has phases, this includes prices across all - # phases of the plan. + # phases of the plan. sig do returns( T::Array[ @@ -59,19 +59,19 @@ module Orb attr_accessor :external_plan_id # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. sig { returns(T.nilable(Integer)) } attr_accessor :net_terms # The status of the plan to create (either active or draft). If not specified, - # this defaults to active. + # this defaults to active. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Status::OrSymbol)) } attr_reader :status @@ -209,17 +209,17 @@ module Orb attr_writer :unit_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration)) } attr_reader :billing_cycle_configuration @@ -241,7 +241,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -250,7 +250,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -259,7 +259,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration)) } attr_reader :invoicing_cycle_configuration @@ -277,8 +277,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -402,7 +402,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -477,7 +477,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -567,17 +567,17 @@ module Orb attr_writer :package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration)) } attr_reader :billing_cycle_configuration @@ -599,7 +599,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -608,7 +608,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -617,7 +617,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration)) } attr_reader :invoicing_cycle_configuration @@ -635,8 +635,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -744,7 +744,7 @@ module Orb attr_accessor :package_amount # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating sig { returns(Integer) } attr_accessor :package_size @@ -769,7 +769,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -844,7 +844,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -934,17 +934,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration)) } attr_reader :billing_cycle_configuration @@ -966,7 +966,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -975,7 +975,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -984,7 +984,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration)) } attr_reader :invoicing_cycle_configuration @@ -1002,8 +1002,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -1146,8 +1146,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -1182,7 +1182,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -1257,7 +1257,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -1347,17 +1347,17 @@ module Orb attr_writer :tiered_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration)) } attr_reader :billing_cycle_configuration @@ -1379,7 +1379,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -1388,7 +1388,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1397,7 +1397,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration)) } attr_reader :invoicing_cycle_configuration @@ -1415,8 +1415,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -1582,7 +1582,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -1657,7 +1657,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -1750,17 +1750,17 @@ module Orb attr_writer :tiered_bps_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration)) } attr_reader :billing_cycle_configuration @@ -1782,7 +1782,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -1791,7 +1791,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1800,7 +1800,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration) @@ -1822,8 +1822,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -1932,7 +1932,7 @@ module Orb class TieredBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers sig { returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig::Tier]) } attr_accessor :tiers @@ -2014,7 +2014,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -2089,7 +2089,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -2179,17 +2179,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration)) } attr_reader :billing_cycle_configuration @@ -2211,7 +2211,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -2220,7 +2220,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -2229,7 +2229,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration)) } attr_reader :invoicing_cycle_configuration @@ -2247,8 +2247,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -2375,7 +2375,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -2450,7 +2450,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -2540,17 +2540,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration)) } attr_reader :billing_cycle_configuration @@ -2572,7 +2572,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -2581,7 +2581,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -2590,7 +2590,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration)) } attr_reader :invoicing_cycle_configuration @@ -2608,8 +2608,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -2686,7 +2686,7 @@ module Orb class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume sig { returns(T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier]) } attr_accessor :tiers @@ -2782,7 +2782,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -2857,7 +2857,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -2947,17 +2947,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration)) } attr_reader :billing_cycle_configuration @@ -2979,7 +2979,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -2988,7 +2988,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -2997,7 +2997,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig { returns(T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration)) } attr_reader :invoicing_cycle_configuration @@ -3015,8 +3015,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -3164,7 +3164,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -3239,7 +3239,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -3321,17 +3321,17 @@ module Orb attr_accessor :threshold_total_amount_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -3359,7 +3359,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -3368,7 +3368,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -3377,7 +3377,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -3401,8 +3401,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -3550,7 +3550,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -3625,7 +3625,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -3707,17 +3707,17 @@ module Orb attr_accessor :tiered_package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration) @@ -3743,7 +3743,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -3752,7 +3752,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -3761,7 +3761,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration) @@ -3783,8 +3783,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -3911,7 +3911,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -3986,7 +3986,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -4068,17 +4068,17 @@ module Orb attr_accessor :tiered_with_minimum_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration) @@ -4104,7 +4104,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -4113,7 +4113,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -4122,7 +4122,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -4146,8 +4146,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -4287,7 +4287,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4362,7 +4362,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -4444,17 +4444,17 @@ module Orb attr_accessor :unit_with_percent_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration) @@ -4480,7 +4480,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -4489,7 +4489,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -4498,7 +4498,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration) @@ -4520,8 +4520,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -4653,7 +4653,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4728,7 +4728,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -4810,17 +4810,17 @@ module Orb attr_accessor :package_with_allocation_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -4848,7 +4848,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -4857,7 +4857,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -4866,7 +4866,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -4890,8 +4890,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -5039,7 +5039,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5114,7 +5114,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5196,17 +5196,17 @@ module Orb attr_accessor :tiered_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration) @@ -5232,7 +5232,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -5241,7 +5241,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5250,7 +5250,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5274,8 +5274,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -5415,7 +5415,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5490,7 +5490,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5572,17 +5572,17 @@ module Orb attr_accessor :unit_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration) @@ -5608,7 +5608,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -5617,7 +5617,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5626,7 +5626,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5650,8 +5650,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -5791,7 +5791,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5866,7 +5866,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5948,17 +5948,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration) @@ -5984,7 +5984,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -5993,7 +5993,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6002,7 +6002,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6026,8 +6026,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -6167,7 +6167,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -6242,7 +6242,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -6324,17 +6324,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -6362,7 +6362,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -6371,7 +6371,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6380,7 +6380,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6404,8 +6404,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -6553,7 +6553,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -6628,7 +6628,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -6710,17 +6710,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -6748,7 +6748,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -6757,7 +6757,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6766,7 +6766,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6790,8 +6790,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -6939,7 +6939,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7014,7 +7014,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7096,17 +7096,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7134,7 +7134,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -7143,7 +7143,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7152,7 +7152,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7176,8 +7176,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -7325,7 +7325,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7400,7 +7400,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7482,17 +7482,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable(Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration) @@ -7518,7 +7518,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -7527,7 +7527,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7536,7 +7536,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7560,8 +7560,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -7701,7 +7701,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7776,7 +7776,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7858,17 +7858,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7896,7 +7896,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -7905,7 +7905,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7914,7 +7914,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7938,8 +7938,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -8087,7 +8087,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8162,7 +8162,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8244,17 +8244,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -8282,7 +8282,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -8291,7 +8291,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -8300,7 +8300,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -8324,8 +8324,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -8473,7 +8473,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8548,7 +8548,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8634,17 +8634,17 @@ module Orb attr_accessor :scalable_matrix_with_unit_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -8672,7 +8672,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -8681,7 +8681,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -8690,7 +8690,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -8714,8 +8714,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -8863,7 +8863,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8938,7 +8938,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9024,17 +9024,17 @@ module Orb attr_accessor :scalable_matrix_with_tiered_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9062,7 +9062,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -9071,7 +9071,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9080,7 +9080,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9104,8 +9104,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -9253,7 +9253,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9328,7 +9328,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9410,17 +9410,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9448,7 +9448,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -9457,7 +9457,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9466,7 +9466,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9490,8 +9490,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -9639,7 +9639,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9714,7 +9714,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9786,7 +9786,7 @@ module Orb end # The status of the plan to create (either active or draft). If not specified, - # this defaults to active. + # this defaults to active. module Status extend Orb::Internal::Type::Enum diff --git a/rbi/lib/orb/models/plan_list_params.rbi b/rbi/lib/orb/models/plan_list_params.rbi index 30e387c3..7ca1b43c 100644 --- a/rbi/lib/orb/models/plan_list_params.rbi +++ b/rbi/lib/orb/models/plan_list_params.rbi @@ -19,7 +19,7 @@ module Orb attr_accessor :created_at_lte # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/plan_update_params.rbi b/rbi/lib/orb/models/plan_update_params.rbi index e9612477..0c0e701c 100644 --- a/rbi/lib/orb/models/plan_update_params.rbi +++ b/rbi/lib/orb/models/plan_update_params.rbi @@ -7,14 +7,14 @@ module Orb include Orb::Internal::Type::RequestParameters # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. sig { returns(T.nilable(String)) } attr_accessor :external_plan_id # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi b/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi index 306f978d..e2279cdb 100644 --- a/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +++ b/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi @@ -8,14 +8,14 @@ module Orb include Orb::Internal::Type::RequestParameters # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. sig { returns(T.nilable(String)) } attr_accessor :external_plan_id # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/price.rbi b/rbi/lib/orb/models/price.rbi index 86b3f905..04561fbe 100644 --- a/rbi/lib/orb/models/price.rbi +++ b/rbi/lib/orb/models/price.rbi @@ -3,15 +3,15 @@ module Orb module Models # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) module Price extend Orb::Internal::Type::Union @@ -111,9 +111,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -422,7 +422,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -441,7 +441,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -599,9 +599,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -917,7 +917,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -936,7 +936,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -959,7 +959,7 @@ module Orb attr_accessor :package_amount # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating sig { returns(Integer) } attr_accessor :package_size @@ -1106,9 +1106,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1449,8 +1449,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -1473,7 +1473,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -1492,7 +1492,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -1639,9 +1639,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -1953,7 +1953,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -1972,7 +1972,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -2164,9 +2164,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -2493,7 +2493,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -2512,7 +2512,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -2545,7 +2545,7 @@ module Orb class TieredBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers sig { returns(T::Array[Orb::Models::Price::TieredBpsPrice::TieredBpsConfig::Tier]) } attr_accessor :tiers @@ -2725,9 +2725,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -3040,7 +3040,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -3059,7 +3059,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -3214,9 +3214,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -3422,7 +3422,7 @@ module Orb class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume sig { returns(T::Array[Orb::Models::Price::BulkBpsPrice::BulkBpsConfig::Tier]) } attr_accessor :tiers @@ -3573,7 +3573,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -3592,7 +3592,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -3745,9 +3745,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -4081,7 +4081,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -4100,7 +4100,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -4253,9 +4253,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -4605,7 +4605,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -4624,7 +4624,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -4776,9 +4776,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -5109,7 +5109,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -5128,7 +5128,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -5283,9 +5283,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -5613,7 +5613,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -5632,7 +5632,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -5786,9 +5786,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -6128,7 +6128,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -6147,7 +6147,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -6311,9 +6311,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -6676,7 +6676,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -6695,7 +6695,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -6852,9 +6852,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -7204,7 +7204,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -7223,7 +7223,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -7379,9 +7379,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -7717,7 +7717,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -7736,7 +7736,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -7901,9 +7901,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -8296,8 +8296,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -8320,7 +8320,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -8339,7 +8339,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -8493,9 +8493,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -8839,7 +8839,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -8858,7 +8858,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -9012,9 +9012,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -9354,7 +9354,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -9373,7 +9373,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -9530,9 +9530,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -9869,7 +9869,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -9888,7 +9888,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -10057,9 +10057,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -10424,7 +10424,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -10443,7 +10443,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -10613,9 +10613,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -10978,7 +10978,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -10997,7 +10997,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -11157,9 +11157,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -11506,7 +11506,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -11525,7 +11525,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -11684,9 +11684,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -12023,7 +12023,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -12042,7 +12042,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -12199,9 +12199,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -12548,7 +12548,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -12567,7 +12567,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -12724,9 +12724,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -13073,7 +13073,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -13092,7 +13092,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -13261,9 +13261,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -13635,7 +13635,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -13654,7 +13654,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -13830,9 +13830,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -14217,7 +14217,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -14236,7 +14236,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -14399,9 +14399,9 @@ module Orb attr_accessor :maximum_amount # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -14748,7 +14748,7 @@ module Orb class Maximum < Orb::Internal::Type::BaseModel # List of price_ids that this maximum amount applies to. For plan/plan phase - # maximums, this can be a subset of prices. + # maximums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -14767,7 +14767,7 @@ module Orb class Minimum < Orb::Internal::Type::BaseModel # List of price_ids that this minimum amount applies to. For plan/plan phase - # minimums, this can be a subset of prices. + # minimums, this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids diff --git a/rbi/lib/orb/models/price_create_params.rbi b/rbi/lib/orb/models/price_create_params.rbi index 2506d9d8..c855aab4 100644 --- a/rbi/lib/orb/models/price_create_params.rbi +++ b/rbi/lib/orb/models/price_create_params.rbi @@ -32,17 +32,17 @@ module Orb attr_writer :unit_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig { returns(T.nilable(Orb::Models::PriceCreateParams::BillingCycleConfiguration)) } attr_reader :billing_cycle_configuration @@ -63,7 +63,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -72,7 +72,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig { returns(T.nilable(Orb::Models::PriceCreateParams::InvoicingCycleConfiguration)) } attr_reader :invoicing_cycle_configuration @@ -85,8 +85,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -402,7 +402,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -460,7 +460,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -515,7 +515,7 @@ module Orb attr_accessor :package_amount # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating sig { returns(Integer) } attr_accessor :package_size @@ -563,8 +563,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -628,8 +628,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -693,7 +693,7 @@ module Orb class TieredBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers sig { returns(T::Array[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier]) } attr_accessor :tiers @@ -769,7 +769,7 @@ module Orb class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume sig { returns(T::Array[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier]) } attr_accessor :tiers diff --git a/rbi/lib/orb/models/price_evaluate_params.rbi b/rbi/lib/orb/models/price_evaluate_params.rbi index f1b6133c..d10936c5 100644 --- a/rbi/lib/orb/models/price_evaluate_params.rbi +++ b/rbi/lib/orb/models/price_evaluate_params.rbi @@ -23,14 +23,14 @@ module Orb attr_accessor :external_customer_id # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the underlying billable metric + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the underlying billable metric sig { returns(T.nilable(String)) } attr_accessor :filter # Properties (or - # [computed properties](/extensibility/advanced-metrics#computed-properties)) used - # to group the underlying billable metric + # [computed properties](/extensibility/advanced-metrics#computed-properties)) used + # to group the underlying billable metric sig { returns(T.nilable(T::Array[String])) } attr_reader :grouping_keys diff --git a/rbi/lib/orb/models/price_list_params.rbi b/rbi/lib/orb/models/price_list_params.rbi index 616eb163..55ab5eb8 100644 --- a/rbi/lib/orb/models/price_list_params.rbi +++ b/rbi/lib/orb/models/price_list_params.rbi @@ -7,7 +7,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/price_update_params.rbi b/rbi/lib/orb/models/price_update_params.rbi index 5cbddba8..81199181 100644 --- a/rbi/lib/orb/models/price_update_params.rbi +++ b/rbi/lib/orb/models/price_update_params.rbi @@ -7,8 +7,8 @@ module Orb include Orb::Internal::Type::RequestParameters # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/prices/external_price_id_update_params.rbi b/rbi/lib/orb/models/prices/external_price_id_update_params.rbi index 60b7005c..4f7bdbc6 100644 --- a/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +++ b/rbi/lib/orb/models/prices/external_price_id_update_params.rbi @@ -8,8 +8,8 @@ module Orb include Orb::Internal::Type::RequestParameters # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata diff --git a/rbi/lib/orb/models/subscription.rbi b/rbi/lib/orb/models/subscription.rbi index 9ebc3027..264c1567 100644 --- a/rbi/lib/orb/models/subscription.rbi +++ b/rbi/lib/orb/models/subscription.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::Subscription::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -34,9 +34,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -44,35 +44,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -80,7 +80,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -113,9 +113,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -124,16 +124,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -169,24 +169,24 @@ module Orb attr_writer :trial_info # A [subscription](/core-concepts#subscription) represents the purchase of a plan - # by a customer. + # by a customer. # - # By default, subscriptions begin on the day that they're created and renew - # automatically for each billing cycle at the cadence that's configured in the - # plan definition. + # By default, subscriptions begin on the day that they're created and renew + # automatically for each billing cycle at the cadence that's configured in the + # plan definition. # - # Subscriptions also default to **beginning of month alignment**, which means the - # first invoice issued for the subscription will have pro-rated charges between - # the `start_date` and the first of the following month. Subsequent billing - # periods will always start and end on a month boundary (e.g. subsequent month - # starts for monthly billing). + # Subscriptions also default to **beginning of month alignment**, which means the + # first invoice issued for the subscription will have pro-rated charges between + # the `start_date` and the first of the following month. Subsequent billing + # periods will always start and end on a month boundary (e.g. subsequent month + # starts for monthly billing). # - # Depending on the plan configuration, any _flat_ recurring fees will be billed - # either at the beginning (in-advance) or end (in-arrears) of each billing cycle. - # Plans default to **in-advance billing**. Usage-based fees are billed in arrears - # as usage is accumulated. In the normal course of events, you can expect an - # invoice to contain usage-based charges for the previous period, and a recurring - # fee for the following period. + # Depending on the plan configuration, any _flat_ recurring fees will be billed + # either at the beginning (in-advance) or end (in-arrears) of each billing cycle. + # Plans default to **in-advance billing**. Usage-based fees are billed in arrears + # as usage is accumulated. In the normal course of events, you can expect an + # invoice to contain usage-based charges for the previous period, and a recurring + # fee for the following period. sig do params( id: String, @@ -374,7 +374,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -387,7 +387,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -437,7 +437,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -446,7 +446,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -508,12 +508,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -575,7 +575,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -584,7 +584,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -649,12 +649,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -716,20 +716,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -821,7 +821,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -885,7 +885,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -972,7 +972,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1028,7 +1028,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1079,19 +1079,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1100,20 +1100,20 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig { returns(T.nilable(T::Array[Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition])) } attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1151,18 +1151,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_cancel_params.rbi b/rbi/lib/orb/models/subscription_cancel_params.rbi index d901d67d..d3c78425 100644 --- a/rbi/lib/orb/models/subscription_cancel_params.rbi +++ b/rbi/lib/orb/models/subscription_cancel_params.rbi @@ -11,13 +11,13 @@ module Orb attr_accessor :cancel_option # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. sig { returns(T.nilable(T::Boolean)) } attr_accessor :allow_invoice_credit_or_void # The date that the cancellation should take effect. This parameter can only be - # passed if the `cancel_option` is `requested_date`. + # passed if the `cancel_option` is `requested_date`. sig { returns(T.nilable(Time)) } attr_accessor :cancellation_date diff --git a/rbi/lib/orb/models/subscription_cancel_response.rbi b/rbi/lib/orb/models/subscription_cancel_response.rbi index a9c0d903..d0cae66c 100644 --- a/rbi/lib/orb/models/subscription_cancel_response.rbi +++ b/rbi/lib/orb/models/subscription_cancel_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionCancelResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -34,9 +34,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -44,35 +44,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -80,7 +80,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -113,9 +113,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -124,16 +124,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -355,7 +355,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -368,7 +368,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -418,7 +418,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -427,7 +427,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -489,12 +489,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -556,7 +556,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -565,7 +565,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -630,12 +630,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -697,20 +697,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -802,7 +802,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -866,7 +866,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -953,7 +953,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1009,7 +1009,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1060,19 +1060,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1081,7 +1081,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable(T::Array[Orb::Models::SubscriptionCancelResponse::PriceInterval::FixedFeeQuantityTransition]) @@ -1090,15 +1090,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1136,18 +1136,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_create_params.rbi b/rbi/lib/orb/models/subscription_create_params.rbi index 53891441..b25f1452 100644 --- a/rbi/lib/orb/models/subscription_create_params.rbi +++ b/rbi/lib/orb/models/subscription_create_params.rbi @@ -7,12 +7,12 @@ module Orb include Orb::Internal::Type::RequestParameters # Additional adjustments to be added to the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionCreateParams::AddAdjustment])) } attr_accessor :add_adjustments # Additional prices to be added to the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionCreateParams::AddPrice])) } attr_accessor :add_prices @@ -23,8 +23,8 @@ module Orb attr_writer :align_billing_with_subscription_start_date # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. If not specified, this - # defaults to the behavior configured for this customer. + # charged with the saved payment method on the due date. If not specified, this + # defaults to the behavior configured for this customer. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -45,8 +45,8 @@ module Orb attr_writer :billing_cycle_anchor_configuration # Redemption code to be used for this subscription. If the coupon cannot be found - # by its redemption code, or cannot be redeemed, an error response will be - # returned and the subscription creation or plan change will not be scheduled. + # by its redemption code, or cannot be redeemed, an error response will be + # returned and the subscription creation or plan change will not be scheduled. sig { returns(T.nilable(String)) } attr_accessor :coupon_redemption_code @@ -57,7 +57,7 @@ module Orb attr_accessor :customer_id # Determines the default memo on this subscription's invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -74,14 +74,14 @@ module Orb attr_accessor :external_marketplace_reporting_id # The external_plan_id of the plan that the given subscription should be switched - # to. Note that either this property or `plan_id` must be specified. + # to. Note that either this property or `plan_id` must be specified. sig { returns(T.nilable(String)) } attr_accessor :external_plan_id # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. sig { returns(T.nilable(String)) } attr_accessor :filter @@ -90,20 +90,20 @@ module Orb attr_accessor :initial_phase_order # When this subscription's accrued usage reaches this threshold, an invoice will - # be issued for the subscription. If not specified, invoices will only be issued - # at the end of the billing period. + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. sig { returns(T.nilable(String)) } attr_accessor :invoicing_threshold # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. If not provided, this defaults to the value specified in the plan. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. If not provided, this defaults to the value specified in the plan. sig { returns(T.nilable(Integer)) } attr_accessor :net_terms @@ -111,12 +111,12 @@ module Orb attr_accessor :per_credit_overage_amount # The plan that the given subscription should be switched to. Note that either - # this property or `external_plan_id` must be specified. + # this property or `external_plan_id` must be specified. sig { returns(T.nilable(String)) } attr_accessor :plan_id # Specifies which version of the plan to subscribe to. If null, the default - # version will be used. + # version will be used. sig { returns(T.nilable(Integer)) } attr_accessor :plan_version_number @@ -125,23 +125,23 @@ module Orb attr_accessor :price_overrides # Plan adjustments to be removed from the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionCreateParams::RemoveAdjustment])) } attr_accessor :remove_adjustments # Plan prices to be removed from the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionCreateParams::RemovePrice])) } attr_accessor :remove_prices # Plan adjustments to be replaced with additional adjustments on the subscription. - # (Only available for accounts that have migrated off of legacy subscription - # overrides) + # (Only available for accounts that have migrated off of legacy subscription + # overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionCreateParams::ReplaceAdjustment])) } attr_accessor :replace_adjustments # Plan prices to be replaced with additional prices on the subscription. (Only - # available for accounts that have migrated off of legacy subscription overrides) + # available for accounts that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionCreateParams::ReplacePrice])) } attr_accessor :replace_prices @@ -149,17 +149,17 @@ module Orb attr_accessor :start_date # The duration of the trial period in days. If not provided, this defaults to the - # value specified in the plan. If `0` is provided, the trial on the plan will be - # skipped. + # value specified in the plan. If `0` is provided, the trial on the plan will be + # skipped. sig { returns(T.nilable(Integer)) } attr_accessor :trial_duration_days # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids @@ -297,7 +297,7 @@ module Orb attr_accessor :adjustment # The end date of the adjustment interval. This is the date that the adjustment - # will stop affecting prices on the subscription. + # will stop affecting prices on the subscription. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -306,8 +306,8 @@ module Orb attr_accessor :plan_phase_order # The start date of the adjustment interval. This is the date that the adjustment - # will start affecting prices on the subscription. If null, the adjustment will - # start when the phase or subscription starts. + # will start affecting prices on the subscription. If null, the adjustment will + # start when the phase or subscription starts. sig { returns(T.nilable(Time)) } attr_accessor :start_date @@ -364,7 +364,7 @@ module Orb attr_accessor :percentage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -414,7 +414,7 @@ module Orb attr_accessor :usage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -464,7 +464,7 @@ module Orb attr_accessor :applies_to_price_ids # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -518,7 +518,7 @@ module Orb attr_accessor :minimum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -571,7 +571,7 @@ module Orb attr_accessor :maximum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -633,13 +633,13 @@ module Orb attr_writer :allocation_price # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this - # price. + # price. sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Discount])) } attr_accessor :discounts # The end date of the price interval. This is the date that the price will stop - # billing on the subscription. If null, billing will end when the phase or - # subscription ends. + # billing on the subscription. If null, billing will end when the phase or + # subscription ends. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -648,12 +648,12 @@ module Orb attr_accessor :external_price_id # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for - # this price. + # this price. sig { returns(T.nilable(String)) } attr_accessor :maximum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for - # this price. + # this price. sig { returns(T.nilable(String)) } attr_accessor :minimum_amount @@ -702,8 +702,8 @@ module Orb attr_accessor :price_id # The start date of the price interval. This is the date that the price will start - # billing on the subscription. If null, billing will start when the phase or - # subscription starts. + # billing on the subscription. If null, billing will start when the phase or + # subscription starts. sig { returns(T.nilable(Time)) } attr_accessor :start_date @@ -822,12 +822,12 @@ module Orb attr_accessor :cadence # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. sig { returns(String) } attr_accessor :currency # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. sig { returns(T::Boolean) } attr_accessor :expires_at_end_of_cadence @@ -904,12 +904,12 @@ module Orb attr_accessor :amount_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. sig { returns(T.nilable(Float)) } attr_accessor :percentage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(T.nilable(Float)) } attr_accessor :usage_discount @@ -1006,17 +1006,17 @@ module Orb attr_writer :unit_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -1044,7 +1044,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -1053,7 +1053,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1062,7 +1062,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -1086,13 +1086,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -1258,7 +1258,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -1333,7 +1333,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -1434,17 +1434,17 @@ module Orb attr_writer :package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -1472,7 +1472,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -1481,7 +1481,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1490,7 +1490,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -1514,13 +1514,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -1668,7 +1668,7 @@ module Orb attr_accessor :package_amount # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating sig { returns(Integer) } attr_accessor :package_size @@ -1693,7 +1693,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -1768,7 +1768,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -1865,17 +1865,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -1903,7 +1903,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -1912,7 +1912,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1921,7 +1921,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -1945,13 +1945,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -2141,8 +2141,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -2177,7 +2177,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -2252,7 +2252,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -2349,17 +2349,17 @@ module Orb attr_writer :tiered_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -2387,7 +2387,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -2396,7 +2396,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -2405,7 +2405,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -2429,13 +2429,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -2650,7 +2650,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -2725,7 +2725,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -2826,17 +2826,17 @@ module Orb attr_writer :tiered_bps_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -2864,7 +2864,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -2873,7 +2873,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -2882,7 +2882,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -2906,13 +2906,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -3058,7 +3058,7 @@ module Orb class TieredBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers sig do returns( T::Array[ @@ -3150,7 +3150,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -3225,7 +3225,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -3322,17 +3322,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -3360,7 +3360,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -3369,7 +3369,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -3378,7 +3378,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -3402,13 +3402,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -3578,7 +3578,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -3653,7 +3653,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -3754,17 +3754,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -3792,7 +3792,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -3801,7 +3801,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -3810,7 +3810,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -3834,13 +3834,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -3927,7 +3927,7 @@ module Orb class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume sig do returns( T::Array[Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BulkBpsConfig::Tier] @@ -4061,7 +4061,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4136,7 +4136,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -4233,17 +4233,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -4271,7 +4271,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -4280,7 +4280,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -4289,7 +4289,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -4313,13 +4313,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -4522,7 +4522,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4597,7 +4597,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -4683,17 +4683,17 @@ module Orb attr_accessor :threshold_total_amount_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -4721,7 +4721,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -4730,7 +4730,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -4739,7 +4739,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -4763,13 +4763,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -4924,7 +4924,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4999,7 +4999,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5085,17 +5085,17 @@ module Orb attr_accessor :tiered_package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -5123,7 +5123,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -5132,7 +5132,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5141,7 +5141,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5165,13 +5165,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -5326,7 +5326,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5401,7 +5401,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5487,17 +5487,17 @@ module Orb attr_accessor :tiered_with_minimum_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -5525,7 +5525,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -5534,7 +5534,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5543,7 +5543,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5567,13 +5567,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -5728,7 +5728,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5803,7 +5803,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5889,17 +5889,17 @@ module Orb attr_accessor :unit_with_percent_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -5927,7 +5927,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -5936,7 +5936,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5945,7 +5945,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5969,13 +5969,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -6130,7 +6130,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -6205,7 +6205,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -6291,17 +6291,17 @@ module Orb attr_accessor :package_with_allocation_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -6329,7 +6329,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -6338,7 +6338,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6347,7 +6347,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6371,13 +6371,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -6532,7 +6532,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -6607,7 +6607,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -6693,17 +6693,17 @@ module Orb attr_accessor :tiered_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -6731,7 +6731,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -6740,7 +6740,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6749,7 +6749,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6773,13 +6773,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -6934,7 +6934,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7009,7 +7009,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7095,17 +7095,17 @@ module Orb attr_accessor :unit_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7133,7 +7133,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -7142,7 +7142,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7151,7 +7151,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7175,13 +7175,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -7336,7 +7336,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7411,7 +7411,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7497,17 +7497,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7535,7 +7535,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -7544,7 +7544,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7553,7 +7553,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7577,13 +7577,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -7738,7 +7738,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7813,7 +7813,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7899,17 +7899,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7937,7 +7937,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -7946,7 +7946,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7955,7 +7955,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7979,13 +7979,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -8140,7 +8140,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8215,7 +8215,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8301,17 +8301,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -8339,7 +8339,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -8348,7 +8348,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -8357,7 +8357,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -8381,13 +8381,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -8542,7 +8542,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8617,7 +8617,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8703,17 +8703,17 @@ module Orb attr_accessor :scalable_matrix_with_unit_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -8741,7 +8741,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -8750,7 +8750,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -8759,7 +8759,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -8783,13 +8783,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -8944,7 +8944,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9019,7 +9019,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9105,17 +9105,17 @@ module Orb attr_accessor :scalable_matrix_with_tiered_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9143,7 +9143,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -9152,7 +9152,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9161,7 +9161,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9185,13 +9185,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -9346,7 +9346,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9421,7 +9421,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9507,17 +9507,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9545,7 +9545,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -9554,7 +9554,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9563,7 +9563,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9587,13 +9587,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -9748,7 +9748,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9823,7 +9823,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9909,17 +9909,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9947,7 +9947,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -9956,7 +9956,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9965,7 +9965,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9989,13 +9989,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -10150,7 +10150,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -10225,7 +10225,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -10311,17 +10311,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -10349,7 +10349,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -10358,7 +10358,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -10367,7 +10367,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -10391,13 +10391,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -10552,7 +10552,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -10627,7 +10627,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -10713,17 +10713,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -10751,7 +10751,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -10760,7 +10760,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -10769,7 +10769,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -10793,13 +10793,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -10954,7 +10954,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -11029,7 +11029,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -11115,17 +11115,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -11153,7 +11153,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -11162,7 +11162,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -11171,7 +11171,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -11195,13 +11195,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -11356,7 +11356,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -11431,7 +11431,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -11505,20 +11505,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -11644,7 +11644,7 @@ module Orb attr_accessor :percentage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -11694,7 +11694,7 @@ module Orb attr_accessor :usage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -11744,7 +11744,7 @@ module Orb attr_accessor :applies_to_price_ids # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -11798,7 +11798,7 @@ module Orb attr_accessor :minimum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -11851,7 +11851,7 @@ module Orb attr_accessor :maximum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -11919,7 +11919,7 @@ module Orb attr_writer :allocation_price # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the - # replacement price. + # replacement price. sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount])) } attr_accessor :discounts @@ -11932,12 +11932,12 @@ module Orb attr_accessor :fixed_price_quantity # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for - # the replacement price. + # the replacement price. sig { returns(T.nilable(String)) } attr_accessor :maximum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for - # the replacement price. + # the replacement price. sig { returns(T.nilable(String)) } attr_accessor :minimum_amount @@ -12095,12 +12095,12 @@ module Orb attr_accessor :cadence # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. sig { returns(String) } attr_accessor :currency # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. sig { returns(T::Boolean) } attr_accessor :expires_at_end_of_cadence @@ -12194,12 +12194,12 @@ module Orb attr_accessor :amount_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. sig { returns(T.nilable(Float)) } attr_accessor :percentage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(T.nilable(Float)) } attr_accessor :usage_discount @@ -12301,17 +12301,17 @@ module Orb attr_writer :unit_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -12339,7 +12339,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -12348,7 +12348,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -12357,7 +12357,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -12381,13 +12381,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -12557,7 +12557,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -12632,7 +12632,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -12733,17 +12733,17 @@ module Orb attr_writer :package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -12771,7 +12771,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -12780,7 +12780,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -12789,7 +12789,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -12813,13 +12813,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -12969,7 +12969,7 @@ module Orb attr_accessor :package_amount # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating sig { returns(Integer) } attr_accessor :package_size @@ -12994,7 +12994,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -13069,7 +13069,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -13170,17 +13170,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -13208,7 +13208,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -13217,7 +13217,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -13226,7 +13226,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -13250,13 +13250,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -13450,8 +13450,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -13486,7 +13486,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -13561,7 +13561,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -13662,17 +13662,17 @@ module Orb attr_writer :tiered_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -13700,7 +13700,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -13709,7 +13709,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -13718,7 +13718,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -13742,13 +13742,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -13967,7 +13967,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -14042,7 +14042,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -14143,17 +14143,17 @@ module Orb attr_writer :tiered_bps_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -14181,7 +14181,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -14190,7 +14190,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -14199,7 +14199,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -14223,13 +14223,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -14375,7 +14375,7 @@ module Orb class TieredBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers sig do returns( T::Array[ @@ -14467,7 +14467,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -14542,7 +14542,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -14639,17 +14639,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -14677,7 +14677,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -14686,7 +14686,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -14695,7 +14695,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -14719,13 +14719,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -14897,7 +14897,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -14972,7 +14972,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -15073,17 +15073,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -15111,7 +15111,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -15120,7 +15120,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -15129,7 +15129,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -15153,13 +15153,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -15246,7 +15246,7 @@ module Orb class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume sig do returns( T::Array[ @@ -15386,7 +15386,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -15461,7 +15461,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -15558,17 +15558,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -15596,7 +15596,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -15605,7 +15605,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -15614,7 +15614,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -15638,13 +15638,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -15851,7 +15851,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -15926,7 +15926,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -16012,17 +16012,17 @@ module Orb attr_accessor :threshold_total_amount_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -16050,7 +16050,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -16059,7 +16059,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -16068,7 +16068,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -16092,13 +16092,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -16253,7 +16253,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -16328,7 +16328,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -16414,17 +16414,17 @@ module Orb attr_accessor :tiered_package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -16452,7 +16452,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -16461,7 +16461,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -16470,7 +16470,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -16494,13 +16494,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -16655,7 +16655,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -16730,7 +16730,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -16816,17 +16816,17 @@ module Orb attr_accessor :tiered_with_minimum_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -16854,7 +16854,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -16863,7 +16863,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -16872,7 +16872,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -16896,13 +16896,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -17057,7 +17057,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -17132,7 +17132,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -17218,17 +17218,17 @@ module Orb attr_accessor :unit_with_percent_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -17256,7 +17256,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -17265,7 +17265,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -17274,7 +17274,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -17298,13 +17298,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -17459,7 +17459,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -17534,7 +17534,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -17620,17 +17620,17 @@ module Orb attr_accessor :package_with_allocation_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -17658,7 +17658,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -17667,7 +17667,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -17676,7 +17676,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -17700,13 +17700,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -17861,7 +17861,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -17936,7 +17936,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -18022,17 +18022,17 @@ module Orb attr_accessor :tiered_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -18060,7 +18060,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -18069,7 +18069,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -18078,7 +18078,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -18102,13 +18102,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -18263,7 +18263,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -18338,7 +18338,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -18424,17 +18424,17 @@ module Orb attr_accessor :unit_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -18462,7 +18462,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -18471,7 +18471,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -18480,7 +18480,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -18504,13 +18504,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -18665,7 +18665,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -18740,7 +18740,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -18826,17 +18826,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -18864,7 +18864,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -18873,7 +18873,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -18882,7 +18882,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -18906,13 +18906,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -19067,7 +19067,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -19142,7 +19142,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -19228,17 +19228,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -19266,7 +19266,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -19275,7 +19275,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -19284,7 +19284,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -19308,13 +19308,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -19469,7 +19469,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -19544,7 +19544,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -19630,17 +19630,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -19668,7 +19668,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -19677,7 +19677,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -19686,7 +19686,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -19710,13 +19710,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -19871,7 +19871,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -19946,7 +19946,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -20032,17 +20032,17 @@ module Orb attr_accessor :scalable_matrix_with_unit_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -20070,7 +20070,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -20079,7 +20079,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -20088,7 +20088,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -20112,13 +20112,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -20273,7 +20273,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -20348,7 +20348,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -20434,17 +20434,17 @@ module Orb attr_accessor :scalable_matrix_with_tiered_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -20472,7 +20472,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -20481,7 +20481,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -20490,7 +20490,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -20514,13 +20514,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -20675,7 +20675,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -20750,7 +20750,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -20836,17 +20836,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -20874,7 +20874,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -20883,7 +20883,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -20892,7 +20892,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -20916,13 +20916,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -21077,7 +21077,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -21152,7 +21152,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -21238,17 +21238,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -21276,7 +21276,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -21285,7 +21285,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -21294,7 +21294,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -21318,13 +21318,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -21479,7 +21479,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -21554,7 +21554,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -21640,17 +21640,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -21678,7 +21678,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -21687,7 +21687,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -21696,7 +21696,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -21720,13 +21720,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -21881,7 +21881,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -21956,7 +21956,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -22042,17 +22042,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -22080,7 +22080,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -22089,7 +22089,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -22098,7 +22098,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -22122,13 +22122,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -22283,7 +22283,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -22358,7 +22358,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -22444,17 +22444,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -22482,7 +22482,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -22491,7 +22491,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -22500,7 +22500,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -22524,13 +22524,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -22685,7 +22685,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -22760,7 +22760,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, diff --git a/rbi/lib/orb/models/subscription_create_response.rbi b/rbi/lib/orb/models/subscription_create_response.rbi index ac29db7e..8827da97 100644 --- a/rbi/lib/orb/models/subscription_create_response.rbi +++ b/rbi/lib/orb/models/subscription_create_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionCreateResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -34,9 +34,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -44,35 +44,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -80,7 +80,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -113,9 +113,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -124,16 +124,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -355,7 +355,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -368,7 +368,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -418,7 +418,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -427,7 +427,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -489,12 +489,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -556,7 +556,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -565,7 +565,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -630,12 +630,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -697,20 +697,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -802,7 +802,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -866,7 +866,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -953,7 +953,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1009,7 +1009,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1060,19 +1060,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1081,7 +1081,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable(T::Array[Orb::Models::SubscriptionCreateResponse::PriceInterval::FixedFeeQuantityTransition]) @@ -1090,15 +1090,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1136,18 +1136,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_fetch_costs_params.rbi b/rbi/lib/orb/models/subscription_fetch_costs_params.rbi index 500772f6..58fb4b0d 100644 --- a/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_costs_params.rbi @@ -19,9 +19,9 @@ module Orb attr_accessor :timeframe_start # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. sig { returns(T.nilable(Orb::Models::SubscriptionFetchCostsParams::ViewMode::OrSymbol)) } attr_accessor :view_mode @@ -59,9 +59,9 @@ module Orb def to_hash; end # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. module ViewMode extend Orb::Internal::Type::Enum diff --git a/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi b/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi index 4c3f0092..fb67404c 100644 --- a/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi @@ -7,7 +7,7 @@ module Orb include Orb::Internal::Type::RequestParameters # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi b/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi index 62ab281b..faa892fa 100644 --- a/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +++ b/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi @@ -47,8 +47,8 @@ module Orb attr_accessor :id # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. sig { returns(T.nilable(String)) } attr_accessor :external_plan_id diff --git a/rbi/lib/orb/models/subscription_fetch_usage_params.rbi b/rbi/lib/orb/models/subscription_fetch_usage_params.rbi index 4e281d86..8fe150c2 100644 --- a/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_usage_params.rbi @@ -7,8 +7,8 @@ module Orb include Orb::Internal::Type::RequestParameters # When specified in conjunction with `group_by`, this parameter filters usage to a - # single billable metric. Note that both `group_by` and `billable_metric_id` must - # be specified together. + # single billable metric. Note that both `group_by` and `billable_metric_id` must + # be specified together. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id @@ -41,9 +41,9 @@ module Orb attr_accessor :timeframe_start # Controls whether Orb returns cumulative usage since the start of the billing - # period, or incremental day-by-day usage. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day usage. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. sig { returns(T.nilable(Orb::Models::SubscriptionFetchUsageParams::ViewMode::OrSymbol)) } attr_accessor :view_mode @@ -111,9 +111,9 @@ module Orb end # Controls whether Orb returns cumulative usage since the start of the billing - # period, or incremental day-by-day usage. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day usage. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. module ViewMode extend Orb::Internal::Type::Enum diff --git a/rbi/lib/orb/models/subscription_list_params.rbi b/rbi/lib/orb/models/subscription_list_params.rbi index b689d861..ccabb3f2 100644 --- a/rbi/lib/orb/models/subscription_list_params.rbi +++ b/rbi/lib/orb/models/subscription_list_params.rbi @@ -19,7 +19,7 @@ module Orb attr_accessor :created_at_lte # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. sig { returns(T.nilable(String)) } attr_accessor :cursor diff --git a/rbi/lib/orb/models/subscription_price_intervals_params.rbi b/rbi/lib/orb/models/subscription_price_intervals_params.rbi index 9c5100ab..494ceead 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_params.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_params.rbi @@ -29,8 +29,8 @@ module Orb attr_writer :add_adjustments # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. sig { returns(T.nilable(T::Boolean)) } attr_accessor :allow_invoice_credit_or_void @@ -92,7 +92,7 @@ module Orb class Add < Orb::Internal::Type::BaseModel # The start date of the price interval. This is the date that the price will start - # billing on the subscription. + # billing on the subscription. sig { returns(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol)) } attr_accessor :start_date @@ -127,7 +127,7 @@ module Orb attr_accessor :discounts # The end date of the price interval. This is the date that the price will stop - # billing on the subscription. + # billing on the subscription. sig { returns(T.nilable(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol))) } attr_accessor :end_date @@ -136,9 +136,9 @@ module Orb attr_accessor :external_price_id # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. sig { returns(T.nilable(String)) } attr_accessor :filter @@ -151,12 +151,12 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The maximum amount that will be billed for this price interval for a given - # billing period. + # billing period. sig { returns(T.nilable(Float)) } attr_accessor :maximum_amount # The minimum amount that will be billed for this price interval for a given - # billing period. + # billing period. sig { returns(T.nilable(Float)) } attr_accessor :minimum_amount @@ -204,11 +204,11 @@ module Orb attr_accessor :price_id # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids @@ -354,7 +354,7 @@ module Orb def to_hash; end # The start date of the price interval. This is the date that the price will start - # billing on the subscription. + # billing on the subscription. module StartDate extend Orb::Internal::Type::Union @@ -372,12 +372,12 @@ module Orb attr_accessor :cadence # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. sig { returns(String) } attr_accessor :currency # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. sig { returns(T::Boolean) } attr_accessor :expires_at_end_of_cadence @@ -479,7 +479,7 @@ module Orb attr_accessor :discount_type # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -495,7 +495,7 @@ module Orb attr_accessor :discount_type # Only available if discount_type is `usage`. Number of usage units that this - # discount is for. + # discount is for. sig { returns(Float) } attr_accessor :usage_discount @@ -516,7 +516,7 @@ module Orb end # The end date of the price interval. This is the date that the price will stop - # billing on the subscription. + # billing on the subscription. module EndDate extend Orb::Internal::Type::Union @@ -583,17 +583,17 @@ module Orb attr_writer :unit_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -625,7 +625,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -634,7 +634,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -658,8 +658,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -822,7 +822,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -897,7 +897,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -998,17 +998,17 @@ module Orb attr_writer :package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -1040,7 +1040,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1049,7 +1049,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -1073,8 +1073,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -1217,7 +1217,7 @@ module Orb attr_accessor :package_amount # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating sig { returns(Integer) } attr_accessor :package_size @@ -1242,7 +1242,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -1317,7 +1317,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -1418,17 +1418,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -1460,7 +1460,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1469,7 +1469,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -1493,8 +1493,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -1681,8 +1681,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -1717,7 +1717,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -1792,7 +1792,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -1897,17 +1897,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -1939,7 +1939,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1948,7 +1948,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -1972,8 +1972,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -2170,8 +2170,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -2206,7 +2206,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -2281,7 +2281,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -2382,17 +2382,17 @@ module Orb attr_writer :tiered_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -2424,7 +2424,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -2433,7 +2433,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -2457,8 +2457,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -2670,7 +2670,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -2745,7 +2745,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -2850,17 +2850,17 @@ module Orb attr_writer :tiered_bps_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -2892,7 +2892,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -2901,7 +2901,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -2925,8 +2925,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -3069,7 +3069,7 @@ module Orb class TieredBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers sig do returns( T::Array[ @@ -3161,7 +3161,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -3236,7 +3236,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -3333,17 +3333,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -3375,7 +3375,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -3384,7 +3384,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -3408,8 +3408,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -3576,7 +3576,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -3651,7 +3651,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -3752,17 +3752,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -3794,7 +3794,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -3803,7 +3803,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -3827,8 +3827,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -3912,7 +3912,7 @@ module Orb class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume sig do returns( T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BulkBpsConfig::Tier] @@ -4044,7 +4044,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4119,7 +4119,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -4220,17 +4220,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -4262,7 +4262,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -4271,7 +4271,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -4295,8 +4295,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -4496,7 +4496,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4571,7 +4571,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -4661,17 +4661,17 @@ module Orb attr_accessor :threshold_total_amount_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -4703,7 +4703,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -4712,7 +4712,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -4736,8 +4736,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -4889,7 +4889,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4964,7 +4964,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5054,17 +5054,17 @@ module Orb attr_accessor :tiered_package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -5096,7 +5096,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5105,7 +5105,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5129,8 +5129,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -5282,7 +5282,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5357,7 +5357,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5447,17 +5447,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -5489,7 +5489,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5498,7 +5498,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5522,8 +5522,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -5675,7 +5675,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5750,7 +5750,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5840,17 +5840,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -5882,7 +5882,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5891,7 +5891,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5915,8 +5915,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -6068,7 +6068,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -6143,7 +6143,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -6233,17 +6233,17 @@ module Orb attr_accessor :tiered_with_minimum_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -6275,7 +6275,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6284,7 +6284,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6308,8 +6308,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -6461,7 +6461,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -6536,7 +6536,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -6626,17 +6626,17 @@ module Orb attr_accessor :package_with_allocation_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -6668,7 +6668,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6677,7 +6677,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6701,8 +6701,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -6854,7 +6854,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -6929,7 +6929,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7019,17 +7019,17 @@ module Orb attr_accessor :tiered_package_with_minimum_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7061,7 +7061,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7070,7 +7070,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7094,8 +7094,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -7247,7 +7247,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7322,7 +7322,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7412,17 +7412,17 @@ module Orb attr_accessor :unit_with_percent_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7454,7 +7454,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7463,7 +7463,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7487,8 +7487,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -7640,7 +7640,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7715,7 +7715,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7805,17 +7805,17 @@ module Orb attr_accessor :tiered_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7847,7 +7847,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7856,7 +7856,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7880,8 +7880,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -8033,7 +8033,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8108,7 +8108,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8198,17 +8198,17 @@ module Orb attr_accessor :unit_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -8240,7 +8240,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -8249,7 +8249,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -8273,8 +8273,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -8426,7 +8426,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8501,7 +8501,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8591,17 +8591,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -8633,7 +8633,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -8642,7 +8642,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -8666,8 +8666,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -8819,7 +8819,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8894,7 +8894,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8984,17 +8984,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9026,7 +9026,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9035,7 +9035,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9059,8 +9059,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -9212,7 +9212,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9287,7 +9287,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9377,17 +9377,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9419,7 +9419,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9428,7 +9428,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9452,8 +9452,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -9605,7 +9605,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9680,7 +9680,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9770,17 +9770,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9812,7 +9812,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9821,7 +9821,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9845,8 +9845,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -9998,7 +9998,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -10073,7 +10073,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -10163,17 +10163,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -10205,7 +10205,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -10214,7 +10214,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -10238,8 +10238,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -10391,7 +10391,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -10466,7 +10466,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -10556,17 +10556,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -10598,7 +10598,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -10607,7 +10607,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -10631,8 +10631,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -10784,7 +10784,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -10859,7 +10859,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -10949,17 +10949,17 @@ module Orb attr_accessor :scalable_matrix_with_unit_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -10991,7 +10991,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -11000,7 +11000,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -11024,8 +11024,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -11177,7 +11177,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -11252,7 +11252,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -11342,17 +11342,17 @@ module Orb attr_accessor :scalable_matrix_with_tiered_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -11384,7 +11384,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -11393,7 +11393,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -11417,8 +11417,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -11570,7 +11570,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -11645,7 +11645,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -11735,17 +11735,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -11777,7 +11777,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -11786,7 +11786,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -11810,8 +11810,8 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata @@ -11963,7 +11963,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -12038,7 +12038,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -12126,16 +12126,16 @@ module Orb attr_accessor :adjustment # The start date of the adjustment interval. This is the date that the adjustment - # will start affecting prices on the subscription. The adjustment will apply to - # invoice dates that overlap with this `start_date`. This `start_date` is treated - # as inclusive for in-advance prices, and exclusive for in-arrears prices. + # will start affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `start_date`. This `start_date` is treated + # as inclusive for in-advance prices, and exclusive for in-arrears prices. sig { returns(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol)) } attr_accessor :start_date # The end date of the adjustment interval. This is the date that the adjustment - # will stop affecting prices on the subscription. The adjustment will apply to - # invoice dates that overlap with this `end_date`.This `end_date` is treated as - # exclusive for in-advance prices, and inclusive for in-arrears prices. + # will stop affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `end_date`.This `end_date` is treated as + # exclusive for in-advance prices, and inclusive for in-arrears prices. sig { returns(T.nilable(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol))) } attr_accessor :end_date @@ -12190,7 +12190,7 @@ module Orb attr_accessor :percentage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -12240,7 +12240,7 @@ module Orb attr_accessor :usage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -12290,7 +12290,7 @@ module Orb attr_accessor :applies_to_price_ids # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -12344,7 +12344,7 @@ module Orb attr_accessor :minimum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -12397,7 +12397,7 @@ module Orb attr_accessor :maximum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -12445,9 +12445,9 @@ module Orb end # The start date of the adjustment interval. This is the date that the adjustment - # will start affecting prices on the subscription. The adjustment will apply to - # invoice dates that overlap with this `start_date`. This `start_date` is treated - # as inclusive for in-advance prices, and exclusive for in-arrears prices. + # will start affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `start_date`. This `start_date` is treated + # as inclusive for in-advance prices, and exclusive for in-arrears prices. module StartDate extend Orb::Internal::Type::Union @@ -12456,9 +12456,9 @@ module Orb end # The end date of the adjustment interval. This is the date that the adjustment - # will stop affecting prices on the subscription. The adjustment will apply to - # invoice dates that overlap with this `end_date`.This `end_date` is treated as - # exclusive for in-advance prices, and inclusive for in-arrears prices. + # will stop affecting prices on the subscription. The adjustment will apply to + # invoice dates that overlap with this `end_date`.This `end_date` is treated as + # exclusive for in-advance prices, and inclusive for in-arrears prices. module EndDate extend Orb::Internal::Type::Union @@ -12473,26 +12473,26 @@ module Orb attr_accessor :price_interval_id # The updated billing cycle day for this price interval. If not specified, the - # billing cycle day will not be updated. Note that overlapping price intervals - # must have the same billing cycle day. + # billing cycle day will not be updated. Note that overlapping price intervals + # must have the same billing cycle day. sig { returns(T.nilable(Integer)) } attr_accessor :billing_cycle_day # The updated end date of this price interval. If not specified, the start date - # will not be updated. + # will not be updated. sig { returns(T.nilable(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol))) } attr_accessor :end_date # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. sig { returns(T.nilable(String)) } attr_accessor :filter # A list of fixed fee quantity transitions to use for this price interval. Note - # that this list will overwrite all existing fixed fee quantity transitions on the - # price interval. + # that this list will overwrite all existing fixed fee quantity transitions on the + # price interval. sig do returns( T.nilable(T::Array[Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition]) @@ -12501,7 +12501,7 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The updated start date of this price interval. If not specified, the start date - # will not be updated. + # will not be updated. sig { returns(T.nilable(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol))) } attr_reader :start_date @@ -12509,11 +12509,11 @@ module Orb attr_writer :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids @@ -12562,7 +12562,7 @@ module Orb def to_hash; end # The updated end date of this price interval. If not specified, the start date - # will not be updated. + # will not be updated. module EndDate extend Orb::Internal::Type::Union @@ -12587,7 +12587,7 @@ module Orb end # The updated start date of this price interval. If not specified, the start date - # will not be updated. + # will not be updated. module StartDate extend Orb::Internal::Type::Union @@ -12602,12 +12602,12 @@ module Orb attr_accessor :adjustment_interval_id # The updated end date of this adjustment interval. If not specified, the start - # date will not be updated. + # date will not be updated. sig { returns(T.nilable(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol))) } attr_accessor :end_date # The updated start date of this adjustment interval. If not specified, the start - # date will not be updated. + # date will not be updated. sig { returns(T.nilable(T.any(Time, Orb::Models::BillingCycleRelativeDate::OrSymbol))) } attr_reader :start_date @@ -12637,7 +12637,7 @@ module Orb def to_hash; end # The updated end date of this adjustment interval. If not specified, the start - # date will not be updated. + # date will not be updated. module EndDate extend Orb::Internal::Type::Union @@ -12646,7 +12646,7 @@ module Orb end # The updated start date of this adjustment interval. If not specified, the start - # date will not be updated. + # date will not be updated. module StartDate extend Orb::Internal::Type::Union diff --git a/rbi/lib/orb/models/subscription_price_intervals_response.rbi b/rbi/lib/orb/models/subscription_price_intervals_response.rbi index 08402acd..74946de1 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_response.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -37,9 +37,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -47,35 +47,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -83,7 +83,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -116,9 +116,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -127,16 +127,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -366,7 +366,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -379,7 +379,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -429,7 +429,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -438,7 +438,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -500,12 +500,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -567,7 +567,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -576,7 +576,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -641,12 +641,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -708,20 +708,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -813,7 +813,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -877,7 +877,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -964,7 +964,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1020,7 +1020,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1071,19 +1071,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1092,7 +1092,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable( @@ -1103,15 +1103,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1149,18 +1149,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi b/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi index 9421e0aa..e615d5a9 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi @@ -10,29 +10,29 @@ module Orb attr_accessor :change_option # Additional adjustments to be added to the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment])) } attr_accessor :add_adjustments # Additional prices to be added to the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice])) } attr_accessor :add_prices # [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be - # aligned with the plan change's effective date. + # aligned with the plan change's effective date. sig { returns(T.nilable(T::Boolean)) } attr_accessor :align_billing_with_plan_change_date # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. If not specified, this - # defaults to the behavior configured for this customer. + # charged with the saved payment method on the due date. If not specified, this + # defaults to the behavior configured for this customer. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection # Reset billing periods to be aligned with the plan change's effective date or - # start of the month. Defaults to `unchanged` which keeps subscription's existing - # billing cycle alignment. + # start of the month. Defaults to `unchanged` which keeps subscription's existing + # billing cycle alignment. sig { returns(T.nilable(Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::OrSymbol)) } attr_accessor :billing_cycle_alignment @@ -53,14 +53,14 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The date that the plan change should take effect. This parameter can only be - # passed if the `change_option` is `requested_date`. If a date with no time is - # passed, the plan change will happen at midnight in the customer's timezone. + # passed if the `change_option` is `requested_date`. If a date with no time is + # passed, the plan change will happen at midnight in the customer's timezone. sig { returns(T.nilable(Time)) } attr_accessor :change_date # Redemption code to be used for this subscription. If the coupon cannot be found - # by its redemption code, or cannot be redeemed, an error response will be - # returned and the subscription creation or plan change will not be scheduled. + # by its redemption code, or cannot be redeemed, an error response will be + # returned and the subscription creation or plan change will not be scheduled. sig { returns(T.nilable(String)) } attr_accessor :coupon_redemption_code @@ -68,19 +68,19 @@ module Orb attr_accessor :credits_overage_rate # Determines the default memo on this subscription's invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo # The external_plan_id of the plan that the given subscription should be switched - # to. Note that either this property or `plan_id` must be specified. + # to. Note that either this property or `plan_id` must be specified. sig { returns(T.nilable(String)) } attr_accessor :external_plan_id # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. sig { returns(T.nilable(String)) } attr_accessor :filter @@ -89,14 +89,14 @@ module Orb attr_accessor :initial_phase_order # When this subscription's accrued usage reaches this threshold, an invoice will - # be issued for the subscription. If not specified, invoices will only be issued - # at the end of the billing period. + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. sig { returns(T.nilable(String)) } attr_accessor :invoicing_threshold # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. If not provided, this defaults to the value specified in the plan. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. If not provided, this defaults to the value specified in the plan. sig { returns(T.nilable(Integer)) } attr_accessor :net_terms @@ -104,12 +104,12 @@ module Orb attr_accessor :per_credit_overage_amount # The plan that the given subscription should be switched to. Note that either - # this property or `external_plan_id` must be specified. + # this property or `external_plan_id` must be specified. sig { returns(T.nilable(String)) } attr_accessor :plan_id # Specifies which version of the plan to change to. If null, the default version - # will be used. + # will be used. sig { returns(T.nilable(Integer)) } attr_accessor :plan_version_number @@ -118,38 +118,38 @@ module Orb attr_accessor :price_overrides # Plan adjustments to be removed from the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::RemoveAdjustment])) } attr_accessor :remove_adjustments # Plan prices to be removed from the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::RemovePrice])) } attr_accessor :remove_prices # Plan adjustments to be replaced with additional adjustments on the subscription. - # (Only available for accounts that have migrated off of legacy subscription - # overrides) + # (Only available for accounts that have migrated off of legacy subscription + # overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment])) } attr_accessor :replace_adjustments # Plan prices to be replaced with additional prices on the subscription. (Only - # available for accounts that have migrated off of legacy subscription overrides) + # available for accounts that have migrated off of legacy subscription overrides) sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice])) } attr_accessor :replace_prices # The duration of the trial period in days. If not provided, this defaults to the - # value specified in the plan. If `0` is provided, the trial on the plan will be - # skipped. + # value specified in the plan. If `0` is provided, the trial on the plan will be + # skipped. sig { returns(T.nilable(Integer)) } attr_accessor :trial_duration_days # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids @@ -305,7 +305,7 @@ module Orb attr_accessor :adjustment # The end date of the adjustment interval. This is the date that the adjustment - # will stop affecting prices on the subscription. + # will stop affecting prices on the subscription. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -314,8 +314,8 @@ module Orb attr_accessor :plan_phase_order # The start date of the adjustment interval. This is the date that the adjustment - # will start affecting prices on the subscription. If null, the adjustment will - # start when the phase or subscription starts. + # will start affecting prices on the subscription. If null, the adjustment will + # start when the phase or subscription starts. sig { returns(T.nilable(Time)) } attr_accessor :start_date @@ -372,7 +372,7 @@ module Orb attr_accessor :percentage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -422,7 +422,7 @@ module Orb attr_accessor :usage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -472,7 +472,7 @@ module Orb attr_accessor :applies_to_price_ids # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -526,7 +526,7 @@ module Orb attr_accessor :minimum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -579,7 +579,7 @@ module Orb attr_accessor :maximum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -646,13 +646,13 @@ module Orb attr_writer :allocation_price # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for this - # price. + # price. sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount])) } attr_accessor :discounts # The end date of the price interval. This is the date that the price will stop - # billing on the subscription. If null, billing will end when the phase or - # subscription ends. + # billing on the subscription. If null, billing will end when the phase or + # subscription ends. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -661,12 +661,12 @@ module Orb attr_accessor :external_price_id # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for - # this price. + # this price. sig { returns(T.nilable(String)) } attr_accessor :maximum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for - # this price. + # this price. sig { returns(T.nilable(String)) } attr_accessor :minimum_amount @@ -715,8 +715,8 @@ module Orb attr_accessor :price_id # The start date of the price interval. This is the date that the price will start - # billing on the subscription. If null, billing will start when the phase or - # subscription starts. + # billing on the subscription. If null, billing will start when the phase or + # subscription starts. sig { returns(T.nilable(Time)) } attr_accessor :start_date @@ -840,12 +840,12 @@ module Orb attr_accessor :cadence # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. sig { returns(String) } attr_accessor :currency # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. sig { returns(T::Boolean) } attr_accessor :expires_at_end_of_cadence @@ -939,12 +939,12 @@ module Orb attr_accessor :amount_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. sig { returns(T.nilable(Float)) } attr_accessor :percentage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(T.nilable(Float)) } attr_accessor :usage_discount @@ -1056,17 +1056,17 @@ module Orb attr_writer :unit_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -1094,7 +1094,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -1103,7 +1103,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1112,7 +1112,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -1136,13 +1136,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -1312,7 +1312,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -1387,7 +1387,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -1488,17 +1488,17 @@ module Orb attr_writer :package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -1526,7 +1526,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -1535,7 +1535,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1544,7 +1544,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -1568,13 +1568,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -1724,7 +1724,7 @@ module Orb attr_accessor :package_amount # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating sig { returns(Integer) } attr_accessor :package_size @@ -1749,7 +1749,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -1824,7 +1824,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -1925,17 +1925,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -1963,7 +1963,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -1972,7 +1972,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -1981,7 +1981,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -2005,13 +2005,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -2205,8 +2205,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -2241,7 +2241,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -2316,7 +2316,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -2417,17 +2417,17 @@ module Orb attr_writer :tiered_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -2455,7 +2455,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -2464,7 +2464,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -2473,7 +2473,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -2497,13 +2497,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -2726,7 +2726,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -2801,7 +2801,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -2902,17 +2902,17 @@ module Orb attr_writer :tiered_bps_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -2940,7 +2940,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -2949,7 +2949,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -2958,7 +2958,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -2982,13 +2982,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -3134,7 +3134,7 @@ module Orb class TieredBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers sig do returns( T::Array[ @@ -3226,7 +3226,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -3301,7 +3301,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -3402,17 +3402,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -3440,7 +3440,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -3449,7 +3449,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -3458,7 +3458,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -3482,13 +3482,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -3662,7 +3662,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -3737,7 +3737,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -3838,17 +3838,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -3876,7 +3876,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -3885,7 +3885,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -3894,7 +3894,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -3918,13 +3918,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -4011,7 +4011,7 @@ module Orb class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume sig do returns( T::Array[ @@ -4151,7 +4151,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4226,7 +4226,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -4327,17 +4327,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -4365,7 +4365,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -4374,7 +4374,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -4383,7 +4383,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -4407,13 +4407,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -4624,7 +4624,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -4699,7 +4699,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -4785,17 +4785,17 @@ module Orb attr_accessor :threshold_total_amount_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -4823,7 +4823,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -4832,7 +4832,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -4841,7 +4841,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -4865,13 +4865,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -5026,7 +5026,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5101,7 +5101,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5187,17 +5187,17 @@ module Orb attr_accessor :tiered_package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -5225,7 +5225,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -5234,7 +5234,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5243,7 +5243,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5267,13 +5267,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -5428,7 +5428,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5503,7 +5503,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5589,17 +5589,17 @@ module Orb attr_accessor :tiered_with_minimum_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -5627,7 +5627,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -5636,7 +5636,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -5645,7 +5645,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -5669,13 +5669,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -5830,7 +5830,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -5905,7 +5905,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -5991,17 +5991,17 @@ module Orb attr_accessor :unit_with_percent_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -6029,7 +6029,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -6038,7 +6038,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6047,7 +6047,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6071,13 +6071,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -6232,7 +6232,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -6307,7 +6307,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -6393,17 +6393,17 @@ module Orb attr_accessor :package_with_allocation_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -6431,7 +6431,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -6440,7 +6440,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6449,7 +6449,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6473,13 +6473,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -6634,7 +6634,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -6709,7 +6709,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -6795,17 +6795,17 @@ module Orb attr_accessor :tiered_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -6833,7 +6833,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -6842,7 +6842,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -6851,7 +6851,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -6875,13 +6875,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -7036,7 +7036,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7111,7 +7111,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7197,17 +7197,17 @@ module Orb attr_accessor :unit_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7235,7 +7235,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -7244,7 +7244,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7253,7 +7253,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7277,13 +7277,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -7438,7 +7438,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7513,7 +7513,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -7599,17 +7599,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -7637,7 +7637,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -7646,7 +7646,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -7655,7 +7655,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -7679,13 +7679,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -7840,7 +7840,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -7915,7 +7915,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8001,17 +8001,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -8039,7 +8039,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -8048,7 +8048,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -8057,7 +8057,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -8081,13 +8081,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -8242,7 +8242,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8317,7 +8317,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8403,17 +8403,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -8441,7 +8441,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -8450,7 +8450,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -8459,7 +8459,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -8483,13 +8483,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -8644,7 +8644,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -8719,7 +8719,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -8805,17 +8805,17 @@ module Orb attr_accessor :scalable_matrix_with_unit_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -8843,7 +8843,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -8852,7 +8852,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -8861,7 +8861,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -8885,13 +8885,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -9046,7 +9046,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9121,7 +9121,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9207,17 +9207,17 @@ module Orb attr_accessor :scalable_matrix_with_tiered_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9245,7 +9245,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -9254,7 +9254,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9263,7 +9263,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9287,13 +9287,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -9448,7 +9448,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9523,7 +9523,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -9609,17 +9609,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -9647,7 +9647,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -9656,7 +9656,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -9665,7 +9665,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -9689,13 +9689,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -9850,7 +9850,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -9925,7 +9925,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -10011,17 +10011,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -10049,7 +10049,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -10058,7 +10058,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -10067,7 +10067,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -10091,13 +10091,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -10252,7 +10252,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -10327,7 +10327,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -10413,17 +10413,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -10451,7 +10451,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -10460,7 +10460,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -10469,7 +10469,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -10493,13 +10493,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -10654,7 +10654,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -10729,7 +10729,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -10815,17 +10815,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -10853,7 +10853,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -10862,7 +10862,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -10871,7 +10871,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -10895,13 +10895,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -11056,7 +11056,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -11131,7 +11131,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -11217,17 +11217,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -11255,7 +11255,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -11264,7 +11264,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -11273,7 +11273,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -11297,13 +11297,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -11458,7 +11458,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -11533,7 +11533,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -11606,8 +11606,8 @@ module Orb end # Reset billing periods to be aligned with the plan change's effective date or - # start of the month. Defaults to `unchanged` which keeps subscription's existing - # billing cycle alignment. + # start of the month. Defaults to `unchanged` which keeps subscription's existing + # billing cycle alignment. module BillingCycleAlignment extend Orb::Internal::Type::Enum @@ -11644,20 +11644,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -11768,7 +11768,7 @@ module Orb attr_accessor :percentage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -11818,7 +11818,7 @@ module Orb attr_accessor :usage_discount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -11868,7 +11868,7 @@ module Orb attr_accessor :applies_to_price_ids # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -11922,7 +11922,7 @@ module Orb attr_accessor :minimum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -11975,7 +11975,7 @@ module Orb attr_accessor :maximum_amount # When false, this adjustment will be applied to a single price. Otherwise, it - # will be applied at the invoice level, possibly to multiple prices. + # will be applied at the invoice level, possibly to multiple prices. sig { returns(T.nilable(T::Boolean)) } attr_reader :is_invoice_level @@ -12046,7 +12046,7 @@ module Orb attr_writer :allocation_price # [DEPRECATED] Use add_adjustments instead. The subscription's discounts for the - # replacement price. + # replacement price. sig { returns(T.nilable(T::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount])) } attr_accessor :discounts @@ -12059,12 +12059,12 @@ module Orb attr_accessor :fixed_price_quantity # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for - # the replacement price. + # the replacement price. sig { returns(T.nilable(String)) } attr_accessor :maximum_amount # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for - # the replacement price. + # the replacement price. sig { returns(T.nilable(String)) } attr_accessor :minimum_amount @@ -12229,12 +12229,12 @@ module Orb attr_accessor :cadence # An ISO 4217 currency string or a custom pricing unit identifier in which to bill - # this price. + # this price. sig { returns(String) } attr_accessor :currency # Whether the allocated amount should expire at the end of the cadence or roll - # over to the next period. + # over to the next period. sig { returns(T::Boolean) } attr_accessor :expires_at_end_of_cadence @@ -12328,12 +12328,12 @@ module Orb attr_accessor :amount_discount # Only available if discount_type is `percentage`. This is a number between 0 - # and 1. + # and 1. sig { returns(T.nilable(Float)) } attr_accessor :percentage_discount # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(T.nilable(Float)) } attr_accessor :usage_discount @@ -12445,17 +12445,17 @@ module Orb attr_writer :unit_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -12483,7 +12483,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -12492,7 +12492,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -12501,7 +12501,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -12525,13 +12525,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -12701,7 +12701,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -12776,7 +12776,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -12877,17 +12877,17 @@ module Orb attr_writer :package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -12915,7 +12915,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -12924,7 +12924,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -12933,7 +12933,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -12957,13 +12957,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -13113,7 +13113,7 @@ module Orb attr_accessor :package_amount # An integer amount to represent package size. For example, 1000 here would divide - # usage by 1000 before multiplying by package_amount in rating + # usage by 1000 before multiplying by package_amount in rating sig { returns(Integer) } attr_accessor :package_size @@ -13138,7 +13138,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -13213,7 +13213,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -13314,17 +13314,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -13352,7 +13352,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -13361,7 +13361,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -13370,7 +13370,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -13394,13 +13394,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -13594,8 +13594,8 @@ module Orb class MatrixValue < Orb::Internal::Type::BaseModel # One or two matrix keys to filter usage to this Matrix value by. For example, - # ["region", "tier"] could be used to filter cloud usage by a cloud region and an - # instance tier. + # ["region", "tier"] could be used to filter cloud usage by a cloud region and an + # instance tier. sig { returns(T::Array[T.nilable(String)]) } attr_accessor :dimension_values @@ -13630,7 +13630,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -13705,7 +13705,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -13806,17 +13806,17 @@ module Orb attr_writer :tiered_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -13844,7 +13844,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -13853,7 +13853,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -13862,7 +13862,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -13886,13 +13886,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -14115,7 +14115,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -14190,7 +14190,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -14291,17 +14291,17 @@ module Orb attr_writer :tiered_bps_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -14329,7 +14329,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -14338,7 +14338,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -14347,7 +14347,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -14371,13 +14371,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -14523,7 +14523,7 @@ module Orb class TieredBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified - # tiers + # tiers sig do returns( T::Array[ @@ -14615,7 +14615,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -14690,7 +14690,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -14791,17 +14791,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -14829,7 +14829,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -14838,7 +14838,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -14847,7 +14847,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -14871,13 +14871,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -15051,7 +15051,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -15126,7 +15126,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -15227,17 +15227,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -15265,7 +15265,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -15274,7 +15274,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -15283,7 +15283,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -15307,13 +15307,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -15400,7 +15400,7 @@ module Orb class BulkBpsConfig < Orb::Internal::Type::BaseModel # Tiers for a bulk BPS pricing model where all usage is aggregated to a single - # tier based on total volume + # tier based on total volume sig do returns( T::Array[ @@ -15540,7 +15540,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -15615,7 +15615,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -15716,17 +15716,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -15754,7 +15754,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -15763,7 +15763,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -15772,7 +15772,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -15796,13 +15796,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -16013,7 +16013,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -16088,7 +16088,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -16174,17 +16174,17 @@ module Orb attr_accessor :threshold_total_amount_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -16212,7 +16212,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -16221,7 +16221,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -16230,7 +16230,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -16254,13 +16254,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -16415,7 +16415,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -16490,7 +16490,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -16576,17 +16576,17 @@ module Orb attr_accessor :tiered_package_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -16614,7 +16614,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -16623,7 +16623,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -16632,7 +16632,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -16656,13 +16656,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -16817,7 +16817,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -16892,7 +16892,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -16978,17 +16978,17 @@ module Orb attr_accessor :tiered_with_minimum_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -17016,7 +17016,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -17025,7 +17025,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -17034,7 +17034,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -17058,13 +17058,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -17219,7 +17219,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -17294,7 +17294,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -17380,17 +17380,17 @@ module Orb attr_accessor :unit_with_percent_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -17418,7 +17418,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -17427,7 +17427,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -17436,7 +17436,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -17460,13 +17460,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -17621,7 +17621,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -17696,7 +17696,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -17782,17 +17782,17 @@ module Orb attr_accessor :package_with_allocation_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -17820,7 +17820,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -17829,7 +17829,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -17838,7 +17838,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -17862,13 +17862,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -18023,7 +18023,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -18098,7 +18098,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -18184,17 +18184,17 @@ module Orb attr_accessor :tiered_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -18222,7 +18222,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -18231,7 +18231,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -18240,7 +18240,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -18264,13 +18264,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -18425,7 +18425,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -18500,7 +18500,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -18586,17 +18586,17 @@ module Orb attr_accessor :unit_with_proration_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -18624,7 +18624,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -18633,7 +18633,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -18642,7 +18642,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -18666,13 +18666,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -18827,7 +18827,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -18902,7 +18902,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -18988,17 +18988,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -19026,7 +19026,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -19035,7 +19035,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -19044,7 +19044,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -19068,13 +19068,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -19229,7 +19229,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -19304,7 +19304,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -19390,17 +19390,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -19428,7 +19428,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -19437,7 +19437,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -19446,7 +19446,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -19470,13 +19470,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -19631,7 +19631,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -19706,7 +19706,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -19792,17 +19792,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -19830,7 +19830,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -19839,7 +19839,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -19848,7 +19848,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -19872,13 +19872,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -20033,7 +20033,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -20108,7 +20108,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -20194,17 +20194,17 @@ module Orb attr_accessor :scalable_matrix_with_unit_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -20232,7 +20232,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -20241,7 +20241,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -20250,7 +20250,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -20274,13 +20274,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -20435,7 +20435,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -20510,7 +20510,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -20596,17 +20596,17 @@ module Orb attr_accessor :scalable_matrix_with_tiered_pricing_config # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -20634,7 +20634,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -20643,7 +20643,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -20652,7 +20652,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -20676,13 +20676,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -20837,7 +20837,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -20912,7 +20912,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -20998,17 +20998,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -21036,7 +21036,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -21045,7 +21045,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -21054,7 +21054,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -21078,13 +21078,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -21239,7 +21239,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -21314,7 +21314,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -21400,17 +21400,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -21438,7 +21438,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -21447,7 +21447,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -21456,7 +21456,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -21480,13 +21480,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -21641,7 +21641,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -21716,7 +21716,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -21802,17 +21802,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -21840,7 +21840,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -21849,7 +21849,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -21858,7 +21858,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -21882,13 +21882,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -22043,7 +22043,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -22118,7 +22118,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -22204,17 +22204,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -22242,7 +22242,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -22251,7 +22251,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -22260,7 +22260,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -22284,13 +22284,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -22445,7 +22445,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -22520,7 +22520,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, @@ -22606,17 +22606,17 @@ module Orb attr_accessor :name # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. sig { returns(T.nilable(String)) } attr_accessor :billable_metric_id # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. sig { returns(T.nilable(T::Boolean)) } attr_accessor :billed_in_advance # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do returns( T.nilable( @@ -22644,7 +22644,7 @@ module Orb attr_accessor :conversion_rate # An ISO 4217 currency string, or custom pricing unit identifier, in which this - # price is billed. + # price is billed. sig { returns(T.nilable(String)) } attr_accessor :currency @@ -22653,7 +22653,7 @@ module Orb attr_accessor :external_price_id # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. sig { returns(T.nilable(Float)) } attr_accessor :fixed_price_quantity @@ -22662,7 +22662,7 @@ module Orb attr_accessor :invoice_grouping_key # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do returns( T.nilable( @@ -22686,13 +22686,13 @@ module Orb attr_writer :invoicing_cycle_configuration # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # A transient ID that can be used to reference this price when adding adjustments - # in the same API call. + # in the same API call. sig { returns(T.nilable(String)) } attr_accessor :reference_id @@ -22847,7 +22847,7 @@ module Orb attr_accessor :duration_unit # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. sig do params( duration: Integer, @@ -22922,7 +22922,7 @@ module Orb attr_accessor :duration_unit # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. sig do params( duration: Integer, diff --git a/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi b/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi index 4e17447f..1a85c417 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -37,9 +37,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -47,35 +47,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -83,7 +83,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -116,9 +116,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -127,16 +127,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -375,7 +375,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -388,7 +388,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -438,7 +438,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -447,7 +447,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -509,12 +509,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -576,7 +576,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -585,7 +585,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -650,12 +650,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -717,20 +717,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -822,7 +822,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -886,7 +886,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -973,7 +973,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1029,7 +1029,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1080,19 +1080,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1101,7 +1101,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable( @@ -1112,15 +1112,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1158,18 +1158,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_trigger_phase_params.rbi b/rbi/lib/orb/models/subscription_trigger_phase_params.rbi index 36d1c9cf..f401a7e5 100644 --- a/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +++ b/rbi/lib/orb/models/subscription_trigger_phase_params.rbi @@ -7,13 +7,13 @@ module Orb include Orb::Internal::Type::RequestParameters # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. sig { returns(T.nilable(T::Boolean)) } attr_accessor :allow_invoice_credit_or_void # The date on which the phase change should take effect. If not provided, defaults - # to today in the customer's timezone. + # to today in the customer's timezone. sig { returns(T.nilable(Date)) } attr_accessor :effective_date diff --git a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi index 843ec8bf..ed64d133 100644 --- a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +++ b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -37,9 +37,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -47,35 +47,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -83,7 +83,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -116,9 +116,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -127,16 +127,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -366,7 +366,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -379,7 +379,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -429,7 +429,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -438,7 +438,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -500,12 +500,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -567,7 +567,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -576,7 +576,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -641,12 +641,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -708,20 +708,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -813,7 +813,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -877,7 +877,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -964,7 +964,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1020,7 +1020,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1071,19 +1071,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1092,7 +1092,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable( @@ -1103,15 +1103,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1149,18 +1149,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi index 88c20195..a19fe995 100644 --- a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -37,9 +37,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -47,35 +47,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -83,7 +83,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -116,9 +116,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -127,16 +127,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -375,7 +375,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -388,7 +388,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -438,7 +438,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -447,7 +447,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -509,12 +509,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -576,7 +576,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -585,7 +585,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -650,12 +650,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -717,20 +717,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -822,7 +822,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -886,7 +886,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -973,7 +973,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1029,7 +1029,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1080,19 +1080,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1101,7 +1101,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable( @@ -1112,15 +1112,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1158,18 +1158,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi index 871f03f2..c4f9d2e8 100644 --- a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -41,9 +41,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -51,35 +51,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -87,7 +87,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -124,9 +124,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -135,16 +135,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -415,7 +415,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -428,7 +428,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -478,7 +478,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -487,7 +487,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -549,12 +549,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -616,7 +616,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -625,7 +625,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -690,12 +690,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -757,20 +757,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -862,7 +862,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -926,7 +926,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -1013,7 +1013,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1069,7 +1069,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1120,19 +1120,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1141,7 +1141,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable( @@ -1154,15 +1154,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1200,18 +1200,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi index 70e2dc80..5ff1c4b9 100644 --- a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -37,9 +37,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -47,35 +47,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -83,7 +83,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -116,9 +116,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -127,16 +127,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -401,7 +401,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -414,7 +414,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -464,7 +464,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -473,7 +473,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -535,12 +535,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -602,7 +602,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -611,7 +611,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -676,12 +676,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -743,20 +743,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -848,7 +848,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -912,7 +912,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -999,7 +999,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1055,7 +1055,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1106,19 +1106,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1127,7 +1127,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable( @@ -1138,15 +1138,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1184,18 +1184,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi index d013dba3..227d3805 100644 --- a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +++ b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi @@ -14,14 +14,14 @@ module Orb attr_accessor :quantity # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. sig { returns(T.nilable(T::Boolean)) } attr_accessor :allow_invoice_credit_or_void # Determines when the change takes effect. Note that if `effective_date` is - # specified, this defaults to `effective_date`. Otherwise, this defaults to - # `immediate` unless it's explicitly set to `upcoming_invoice`. + # specified, this defaults to `effective_date`. Otherwise, this defaults to + # `immediate` unless it's explicitly set to `upcoming_invoice`. sig { returns(T.nilable(Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption::OrSymbol)) } attr_reader :change_option @@ -29,8 +29,8 @@ module Orb attr_writer :change_option # The date that the quantity change should take effect, localized to the - # customer's timezone. Ifthis parameter is not passed in, the quantity change is - # effective according to `change_option`. + # customer's timezone. Ifthis parameter is not passed in, the quantity change is + # effective according to `change_option`. sig { returns(T.nilable(Date)) } attr_accessor :effective_date @@ -69,8 +69,8 @@ module Orb def to_hash; end # Determines when the change takes effect. Note that if `effective_date` is - # specified, this defaults to `effective_date`. Otherwise, this defaults to - # `immediate` unless it's explicitly set to `upcoming_invoice`. + # specified, this defaults to `effective_date`. Otherwise, this defaults to + # `immediate` unless it's explicitly set to `upcoming_invoice`. module ChangeOption extend Orb::Internal::Type::Enum diff --git a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi index 6d79aed3..e21c6666 100644 --- a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +++ b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -37,9 +37,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -47,35 +47,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -83,7 +83,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -116,9 +116,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -127,16 +127,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -375,7 +375,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -388,7 +388,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -438,7 +438,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -447,7 +447,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -509,12 +509,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -576,7 +576,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -585,7 +585,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -650,12 +650,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -717,20 +717,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -822,7 +822,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -886,7 +886,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -973,7 +973,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1029,7 +1029,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1080,19 +1080,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1101,7 +1101,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable( @@ -1112,15 +1112,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1158,18 +1158,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/subscription_update_params.rbi b/rbi/lib/orb/models/subscription_update_params.rbi index adab0f69..e8ca952d 100644 --- a/rbi/lib/orb/models/subscription_update_params.rbi +++ b/rbi/lib/orb/models/subscription_update_params.rbi @@ -7,32 +7,32 @@ module Orb include Orb::Internal::Type::RequestParameters # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection # Determines the default memo on this subscription's invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo # When this subscription's accrued usage reaches this threshold, an invoice will - # be issued for the subscription. If not specified, invoices will only be issued - # at the end of the billing period. + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. sig { returns(T.nilable(String)) } attr_accessor :invoicing_threshold # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(T.nilable(Integer)) } attr_accessor :net_terms diff --git a/rbi/lib/orb/models/subscription_update_trial_params.rbi b/rbi/lib/orb/models/subscription_update_trial_params.rbi index 87d3faa9..a0cd4d80 100644 --- a/rbi/lib/orb/models/subscription_update_trial_params.rbi +++ b/rbi/lib/orb/models/subscription_update_trial_params.rbi @@ -7,12 +7,12 @@ module Orb include Orb::Internal::Type::RequestParameters # The new date that the trial should end, or the literal string `immediate` to end - # the trial immediately. + # the trial immediately. sig { returns(T.any(Time, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol)) } attr_accessor :trial_end_date # If true, shifts subsequent price and adjustment intervals (preserving their - # durations, but adjusting their absolute dates). + # durations, but adjusting their absolute dates). sig { returns(T.nilable(T::Boolean)) } attr_reader :shift @@ -42,7 +42,7 @@ module Orb def to_hash; end # The new date that the trial should end, or the literal string `immediate` to end - # the trial immediately. + # the trial immediately. module TrialEndDate extend Orb::Internal::Type::Union diff --git a/rbi/lib/orb/models/subscription_update_trial_response.rbi b/rbi/lib/orb/models/subscription_update_trial_response.rbi index baa5bcab..912d47b5 100644 --- a/rbi/lib/orb/models/subscription_update_trial_response.rbi +++ b/rbi/lib/orb/models/subscription_update_trial_response.rbi @@ -7,18 +7,18 @@ module Orb attr_accessor :id # The current plan phase that is active, only if the subscription's plan has - # phases. + # phases. sig { returns(T.nilable(Integer)) } attr_accessor :active_plan_phase_order # The adjustment intervals for this subscription sorted by the start_date of the - # adjustment interval. + # adjustment interval. sig { returns(T::Array[Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval]) } attr_accessor :adjustment_intervals # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. If null, defaults to the customer's setting. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. sig { returns(T.nilable(T::Boolean)) } attr_accessor :auto_collection @@ -37,9 +37,9 @@ module Orb attr_writer :billing_cycle_anchor_configuration # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :billing_cycle_day @@ -47,35 +47,35 @@ module Orb attr_accessor :created_at # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is not part of the billing period. Set to null for - # subscriptions that are not currently active. + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if the subscription is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # A customer is a buyer of your products, and the other party to the billing - # relationship. + # relationship. # - # In Orb, customers are assigned system generated identifiers automatically, but - # it's often desirable to have these match existing identifiers in your system. To - # avoid having to denormalize Orb ID information, you can pass in an - # `external_customer_id` with your own identifier. See - # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further - # information about how these aliases work in Orb. + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. # - # In addition to having an identifier in your system, a customer may exist in a - # payment provider solution like Stripe. Use the `payment_provider_id` and the - # `payment_provider` enum field to express this mapping. + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. # - # A customer also has a timezone (from the standard - # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to - # your account's timezone. See [Timezone localization](/essentials/timezones) for - # information on what this timezone parameter influences within Orb. + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. sig { returns(Orb::Models::Customer) } attr_reader :customer @@ -83,7 +83,7 @@ module Orb attr_writer :customer # Determines the default memo on this subscriptions' invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. sig { returns(T.nilable(String)) } attr_accessor :default_invoice_memo @@ -116,9 +116,9 @@ module Orb attr_accessor :maximum_intervals # User specified key-value pairs for the resource. If not present, this defaults - # to an empty dictionary. Individual keys can be removed by setting the value to - # `null`, and the entire metadata mapping can be cleared by setting `metadata` to - # `null`. + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. sig { returns(T::Hash[Symbol, String]) } attr_accessor :metadata @@ -127,16 +127,16 @@ module Orb attr_accessor :minimum_intervals # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. sig { returns(Integer) } attr_accessor :net_terms # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be - # subscribed to by a customer. Plans define the billing behavior of the - # subscription. You can see more about how to configure prices in the - # [Price resource](/reference/price). + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). sig { returns(Orb::Models::Plan) } attr_reader :plan @@ -364,7 +364,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -377,7 +377,7 @@ module Orb attr_accessor :reason # The number of usage units by which to discount the price this adjustment applies - # to in a given billing period. + # to in a given billing period. sig { returns(Float) } attr_accessor :usage_discount @@ -427,7 +427,7 @@ module Orb attr_accessor :adjustment_type # The amount by which to discount the prices this adjustment applies to in a given - # billing period. + # billing period. sig { returns(String) } attr_accessor :amount_discount @@ -436,7 +436,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -498,12 +498,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The percentage (as a value between 0 and 1) by which to discount the price - # intervals this adjustment applies to in a given billing period. + # intervals this adjustment applies to in a given billing period. sig { returns(Float) } attr_accessor :percentage_discount @@ -565,7 +565,7 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level @@ -574,7 +574,7 @@ module Orb attr_accessor :item_id # The minimum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -639,12 +639,12 @@ module Orb attr_accessor :applies_to_price_ids # True for adjustments that apply to an entire invocice, false for adjustments - # that apply to only one price. + # that apply to only one price. sig { returns(T::Boolean) } attr_accessor :is_invoice_level # The maximum amount to charge in a given billing period for the prices this - # adjustment applies to. + # adjustment applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -706,20 +706,20 @@ module Orb class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel # The day of the month on which the billing cycle is anchored. If the maximum - # number of days in a month is greater than this value, the last day of the month - # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing - # period begins on the 30th. + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. sig { returns(Integer) } attr_accessor :day # The month on which the billing cycle is anchored (e.g. a quarterly price - # anchored in February would have cycles starting February, May, August, and - # November). + # anchored in February would have cycles starting February, May, August, and + # November). sig { returns(T.nilable(Integer)) } attr_accessor :month # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle - # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). sig { returns(T.nilable(Integer)) } attr_accessor :year @@ -811,7 +811,7 @@ module Orb attr_accessor :end_date # Only available if discount_type is `percentage`.This is a number between 0 - # and 1. + # and 1. sig { returns(Float) } attr_accessor :percentage_discount @@ -875,7 +875,7 @@ module Orb attr_accessor :start_date # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount @@ -962,7 +962,7 @@ module Orb attr_accessor :end_date # The maximum amount to charge in a given billing period for the price intervals - # this transform applies to. + # this transform applies to. sig { returns(String) } attr_accessor :maximum_amount @@ -1018,7 +1018,7 @@ module Orb attr_accessor :end_date # The minimum amount to charge in a given billing period for the price intervals - # this minimum applies to. + # this minimum applies to. sig { returns(String) } attr_accessor :minimum_amount @@ -1069,19 +1069,19 @@ module Orb attr_accessor :billing_cycle_day # The end of the current billing period. This is an exclusive timestamp, such that - # the instant returned is exactly the end of the billing period. Set to null if - # this price interval is not currently active. + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_end_date # The start date of the current billing period. This is an inclusive timestamp; - # the instant returned is exactly the beginning of the billing period. Set to null - # if this price interval is not currently active. + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. sig { returns(T.nilable(Time)) } attr_accessor :current_billing_period_start_date # The end date of the price interval. This is the date that Orb stops billing for - # this price. + # this price. sig { returns(T.nilable(Time)) } attr_accessor :end_date @@ -1090,7 +1090,7 @@ module Orb attr_accessor :filter # The fixed fee quantity transitions for this price interval. This is only - # relevant for fixed fees. + # relevant for fixed fees. sig do returns( T.nilable( @@ -1101,15 +1101,15 @@ module Orb attr_accessor :fixed_fee_quantity_transitions # The Price resource represents a price that can be billed on a subscription, - # resulting in a charge on an invoice in the form of an invoice line item. Prices - # take a quantity and determine an amount to bill. + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given Price object. The model_type field - # determines the key for the configuration object that is present. + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. # - # For more on the types of prices, see - # [the core concepts documentation](/core-concepts#plan-and-price) + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) sig do returns( T.any( @@ -1147,18 +1147,18 @@ module Orb attr_accessor :price # The start date of the price interval. This is the date that Orb starts billing - # for this price. + # for this price. sig { returns(Time) } attr_accessor :start_date # A list of customer IDs whose usage events will be aggregated and billed under - # this price interval. + # this price interval. sig { returns(T.nilable(T::Array[String])) } attr_accessor :usage_customer_ids # The Price Interval resource represents a period of time for which a price will - # bill on a subscription. A subscription’s price intervals define its billing - # behavior. + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. sig do params( id: String, diff --git a/rbi/lib/orb/models/trial_discount.rbi b/rbi/lib/orb/models/trial_discount.rbi index 62417f4c..cb8e2a48 100644 --- a/rbi/lib/orb/models/trial_discount.rbi +++ b/rbi/lib/orb/models/trial_discount.rbi @@ -4,7 +4,7 @@ module Orb module Models class TrialDiscount < Orb::Internal::Type::BaseModel # List of price_ids that this discount applies to. For plan/plan phase discounts, - # this can be a subset of prices. + # this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids diff --git a/rbi/lib/orb/models/usage_discount.rbi b/rbi/lib/orb/models/usage_discount.rbi index a2388aec..a91b5f1e 100644 --- a/rbi/lib/orb/models/usage_discount.rbi +++ b/rbi/lib/orb/models/usage_discount.rbi @@ -4,7 +4,7 @@ module Orb module Models class UsageDiscount < Orb::Internal::Type::BaseModel # List of price_ids that this discount applies to. For plan/plan phase discounts, - # this can be a subset of prices. + # this can be a subset of prices. sig { returns(T::Array[String]) } attr_accessor :applies_to_price_ids @@ -12,7 +12,7 @@ module Orb attr_accessor :discount_type # Only available if discount_type is `usage`. Number of usage units that this - # discount is for + # discount is for sig { returns(Float) } attr_accessor :usage_discount diff --git a/rbi/lib/orb/request_options.rbi b/rbi/lib/orb/request_options.rbi index 78c81d0e..c886a497 100644 --- a/rbi/lib/orb/request_options.rbi +++ b/rbi/lib/orb/request_options.rbi @@ -2,32 +2,32 @@ module Orb # Specify HTTP behaviour to use for a specific request. These options supplement - # or override those provided at the client level. + # or override those provided at the client level. # - # When making a request, you can pass an actual {RequestOptions} instance, or - # simply pass a Hash with symbol keys matching the attributes on this class. + # When making a request, you can pass an actual {RequestOptions} instance, or + # simply pass a Hash with symbol keys matching the attributes on this class. class RequestOptions < Orb::Internal::Type::BaseModel # @api private sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void } def self.validate!(opts); end # Idempotency key to send with request and all associated retries. Will only be - # sent for write requests. + # sent for write requests. sig { returns(T.nilable(String)) } attr_accessor :idempotency_key # Extra query params to send with the request. These are `.merge`’d into any - # `query` given at the client level. + # `query` given at the client level. sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) } attr_accessor :extra_query # Extra headers to send with the request. These are `.merged`’d into any - # `extra_headers` given at the client level. + # `extra_headers` given at the client level. sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) } attr_accessor :extra_headers # Extra data to send with the request. These are deep merged into any data - # generated as part of the normal request. + # generated as part of the normal request. sig { returns(T.nilable(T.anything)) } attr_accessor :extra_body diff --git a/rbi/lib/orb/resources/alerts.rbi b/rbi/lib/orb/resources/alerts.rbi index 9b8abe16..a463cc17 100644 --- a/rbi/lib/orb/resources/alerts.rbi +++ b/rbi/lib/orb/resources/alerts.rbi @@ -30,15 +30,15 @@ module Orb ); end # This endpoint returns a list of alerts within Orb. # - # The request must specify one of `customer_id`, `external_customer_id`, or - # `subscription_id`. + # The request must specify one of `customer_id`, `external_customer_id`, or + # `subscription_id`. # - # If querying by subscripion_id, the endpoint will return the subscription level - # alerts as well as the plan level alerts associated with the subscription. + # If querying by subscripion_id, the endpoint will return the subscription level + # alerts as well as the plan level alerts associated with the subscription. # - # The list of alerts is ordered starting from the most recently created alert. - # This endpoint follows Orb's - # [standardized pagination format](/api-reference/pagination). + # The list of alerts is ordered starting from the most recently created alert. + # This endpoint follows Orb's + # [standardized pagination format](/api-reference/pagination). sig do params( created_at_gt: T.nilable(Time), @@ -60,7 +60,7 @@ module Orb created_at_lt: nil, created_at_lte: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # Fetch alerts scoped to this customer_id customer_id: nil, @@ -73,13 +73,13 @@ module Orb request_options: {} ); end # This endpoint creates a new alert to monitor a customer's credit balance. There - # are three types of alerts that can be scoped to customers: - # `credit_balance_depleted`, `credit_balance_dropped`, and - # `credit_balance_recovered`. Customers can have a maximum of one of each type of - # alert per [credit balance currency](/product-catalog/prepurchase). - # `credit_balance_dropped` alerts require a list of thresholds to be provided - # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not - # require thresholds. + # are three types of alerts that can be scoped to customers: + # `credit_balance_depleted`, `credit_balance_dropped`, and + # `credit_balance_recovered`. Customers can have a maximum of one of each type of + # alert per [credit balance currency](/product-catalog/prepurchase). + # `credit_balance_dropped` alerts require a list of thresholds to be provided + # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not + # require thresholds. sig do params( customer_id: String, @@ -101,13 +101,13 @@ module Orb request_options: {} ); end # This endpoint creates a new alert to monitor a customer's credit balance. There - # are three types of alerts that can be scoped to customers: - # `credit_balance_depleted`, `credit_balance_dropped`, and - # `credit_balance_recovered`. Customers can have a maximum of one of each type of - # alert per [credit balance currency](/product-catalog/prepurchase). - # `credit_balance_dropped` alerts require a list of thresholds to be provided - # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not - # require thresholds. + # are three types of alerts that can be scoped to customers: + # `credit_balance_depleted`, `credit_balance_dropped`, and + # `credit_balance_recovered`. Customers can have a maximum of one of each type of + # alert per [credit balance currency](/product-catalog/prepurchase). + # `credit_balance_dropped` alerts require a list of thresholds to be provided + # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not + # require thresholds. sig do params( external_customer_id: String, @@ -132,15 +132,15 @@ module Orb ); end # This endpoint is used to create alerts at the subscription level. # - # Subscription level alerts can be one of two types: `usage_exceeded` or - # `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and - # is triggered when the usage of that metric exceeds predefined thresholds during - # the current billing cycle. A `cost_exceeded` alert is triggered when the total - # amount due during the current billing cycle surpasses predefined thresholds. - # `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each - # subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert - # per metric that is a part of the subscription. Alerts are triggered based on - # usage or cost conditions met during the current billing cycle. + # Subscription level alerts can be one of two types: `usage_exceeded` or + # `cost_exceeded`. A `usage_exceeded` alert is scoped to a particular metric and + # is triggered when the usage of that metric exceeds predefined thresholds during + # the current billing cycle. A `cost_exceeded` alert is triggered when the total + # amount due during the current billing cycle surpasses predefined thresholds. + # `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each + # subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert + # per metric that is a part of the subscription. Alerts are triggered based on + # usage or cost conditions met during the current billing cycle. sig do params( subscription_id: String, @@ -162,8 +162,8 @@ module Orb request_options: {} ); end # This endpoint allows you to disable an alert. To disable a plan-level alert for - # a specific subscription, you must include the `subscription_id`. The - # `subscription_id` is not required for customer or subscription level alerts. + # a specific subscription, you must include the `subscription_id`. The + # `subscription_id` is not required for customer or subscription level alerts. sig do params( alert_configuration_id: String, @@ -179,8 +179,8 @@ module Orb request_options: {} ); end # This endpoint allows you to enable an alert. To enable a plan-level alert for a - # specific subscription, you must include the `subscription_id`. The - # `subscription_id` is not required for customer or subscription level alerts. + # specific subscription, you must include the `subscription_id`. The + # `subscription_id` is not required for customer or subscription level alerts. sig do params( alert_configuration_id: String, diff --git a/rbi/lib/orb/resources/coupons.rbi b/rbi/lib/orb/resources/coupons.rbi index b4cde03f..205c9129 100644 --- a/rbi/lib/orb/resources/coupons.rbi +++ b/rbi/lib/orb/resources/coupons.rbi @@ -7,7 +7,7 @@ module Orb attr_reader :subscriptions # This endpoint allows the creation of coupons, which can then be redeemed at - # subscription creation or plan change. + # subscription creation or plan change. sig do params( discount: T.any( @@ -27,19 +27,19 @@ module Orb # This string can be used to redeem this coupon for a given subscription. redemption_code:, # This allows for a coupon's discount to apply for a limited time (determined in - # months); a `null` value here means "unlimited time". + # months); a `null` value here means "unlimited time". duration_in_months: nil, # The maximum number of redemptions allowed for this coupon before it is - # exhausted;`null` here means "unlimited". + # exhausted;`null` here means "unlimited". max_redemptions: nil, request_options: {} ); end # This endpoint returns a list of all coupons for an account in a list format. # - # The list of coupons is ordered starting from the most recently created coupon. - # The response also includes `pagination_metadata`, which lets the caller retrieve - # the next page of results if they exist. More information about pagination can be - # found in the Pagination-metadata schema. + # The list of coupons is ordered starting from the most recently created coupon. + # The response also includes `pagination_metadata`, which lets the caller retrieve + # the next page of results if they exist. More information about pagination can be + # found in the Pagination-metadata schema. sig do params( cursor: T.nilable(String), @@ -52,20 +52,20 @@ module Orb end def list( # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, # Filter to coupons matching this redemption code. redemption_code: nil, # Show archived coupons as well (by default, this endpoint only returns active - # coupons). + # coupons). show_archived: nil, request_options: {} ); end # This endpoint allows a coupon to be archived. Archived coupons can no longer be - # redeemed, and will be hidden from lists of active coupons. Additionally, once a - # coupon is archived, its redemption code can be reused for a different coupon. + # redeemed, and will be hidden from lists of active coupons. Additionally, once a + # coupon is archived, its redemption code can be reused for a different coupon. sig do params( coupon_id: String, @@ -76,8 +76,8 @@ module Orb def archive(coupon_id, request_options: {}); end # This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption - # code, use the [List coupons](list-coupons) endpoint with the redemption_code - # parameter. + # code, use the [List coupons](list-coupons) endpoint with the redemption_code + # parameter. sig do params( coupon_id: String, diff --git a/rbi/lib/orb/resources/coupons/subscriptions.rbi b/rbi/lib/orb/resources/coupons/subscriptions.rbi index 2e14d9ee..abc8c619 100644 --- a/rbi/lib/orb/resources/coupons/subscriptions.rbi +++ b/rbi/lib/orb/resources/coupons/subscriptions.rbi @@ -5,9 +5,9 @@ module Orb class Coupons class Subscriptions # This endpoint returns a list of all subscriptions that have redeemed a given - # coupon as a [paginated](/api-reference/pagination) list, ordered starting from - # the most recently created subscription. For a full discussion of the - # subscription resource, see [Subscription](/core-concepts#subscription). + # coupon as a [paginated](/api-reference/pagination) list, ordered starting from + # the most recently created subscription. For a full discussion of the + # subscription resource, see [Subscription](/core-concepts#subscription). sig do params( coupon_id: String, @@ -20,7 +20,7 @@ module Orb def list( coupon_id, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, diff --git a/rbi/lib/orb/resources/credit_notes.rbi b/rbi/lib/orb/resources/credit_notes.rbi index 341df12d..7f3f90c6 100644 --- a/rbi/lib/orb/resources/credit_notes.rbi +++ b/rbi/lib/orb/resources/credit_notes.rbi @@ -4,7 +4,7 @@ module Orb module Resources class CreditNotes # This endpoint is used to create a single - # [`Credit Note`](/invoicing/credit-notes). + # [`Credit Note`](/invoicing/credit-notes). sig do params( line_items: T::Array[T.any(Orb::Models::CreditNoteCreateParams::LineItem, Orb::Internal::AnyHash)], @@ -23,8 +23,8 @@ module Orb request_options: {} ); end # Get a paginated list of CreditNotes. Users can also filter by customer_id, - # subscription_id, or external_customer_id. The credit notes will be returned in - # reverse chronological order by `creation_time`. + # subscription_id, or external_customer_id. The credit notes will be returned in + # reverse chronological order by `creation_time`. sig do params( created_at_gt: T.nilable(Time), @@ -43,14 +43,14 @@ module Orb created_at_lt: nil, created_at_lte: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} ); end # This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes) - # given an identifier. + # given an identifier. sig do params( credit_note_id: String, diff --git a/rbi/lib/orb/resources/customers.rbi b/rbi/lib/orb/resources/customers.rbi index dfbd13b6..44037d79 100644 --- a/rbi/lib/orb/resources/customers.rbi +++ b/rbi/lib/orb/resources/customers.rbi @@ -13,17 +13,17 @@ module Orb attr_reader :balance_transactions # This operation is used to create an Orb customer, who is party to the core - # billing relationship. See [Customer](/core-concepts##customer) for an overview - # of the customer resource. + # billing relationship. See [Customer](/core-concepts##customer) for an overview + # of the customer resource. # - # This endpoint is critical in the following Orb functionality: + # This endpoint is critical in the following Orb functionality: # - # - Automated charges can be configured by setting `payment_provider` and - # `payment_provider_id` to automatically issue invoices - # - [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured - # by setting `external_customer_id` - # - [Timezone localization](/essentials/timezones) can be configured on a - # per-customer basis by setting the `timezone` parameter + # - Automated charges can be configured by setting `payment_provider` and + # `payment_provider_id` to automatically issue invoices + # - [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured + # by setting `external_customer_id` + # - [Timezone localization](/essentials/timezones) can be configured on a + # per-customer basis by setting the `timezone` parameter sig do params( email: String, @@ -56,161 +56,161 @@ module Orb end def create( # A valid customer email, to be used for notifications. When Orb triggers payment - # through a payment gateway, this email will be used for any automatically issued - # receipts. + # through a payment gateway, this email will be used for any automatically issued + # receipts. email:, # The full name of the customer name:, accounting_sync_configuration: nil, # Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. + # addresses will be CC'd for customer communications. additional_emails: nil, # Used to determine if invoices for this customer will automatically attempt to - # charge a saved payment method, if available. This parameter defaults to `True` - # when a payment provider is provided on customer creation. + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. auto_collection: nil, billing_address: nil, # An ISO 4217 currency string used for the customer's invoices and balance. If not - # set at creation time, will be set at subscription creation time. + # set at creation time, will be set at subscription creation time. currency: nil, email_delivery: nil, # An optional user-defined ID for this customer resource, used throughout the - # system as an alias for this Customer. Use this field to identify a customer by - # an existing identifier in your system. + # system as an alias for this Customer. Use this field to identify a customer by + # an existing identifier in your system. external_customer_id: nil, # The hierarchical relationships for this customer. hierarchy: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode, the connection must first be configured in the Orb - # webapp. + # When not in test mode, the connection must first be configured in the Orb + # webapp. payment_provider: nil, # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | tax_id: nil, # A timezone identifier from the IANA timezone database, such as - # `"America/Los_Angeles"`. This defaults to your account's timezone if not set. - # This cannot be changed after customer creation. + # `"America/Los_Angeles"`. This defaults to your account's timezone if not set. + # This cannot be changed after customer creation. timezone: nil, request_options: {} ); end # This endpoint can be used to update the `payment_provider`, - # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`, - # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and - # `additional_emails` of an existing customer. Other fields on a customer are - # currently immutable. + # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`, + # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and + # `additional_emails` of an existing customer. Other fields on a customer are + # currently immutable. sig do params( customer_id: String, @@ -245,158 +245,158 @@ module Orb customer_id, accounting_sync_configuration: nil, # Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. + # addresses will be CC'd for customer communications. additional_emails: nil, # Used to determine if invoices for this customer will automatically attempt to - # charge a saved payment method, if available. This parameter defaults to `True` - # when a payment provider is provided on customer creation. + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. auto_collection: nil, billing_address: nil, # An ISO 4217 currency string used for the customer's invoices and balance. If not - # set at creation time, will be set at subscription creation time. + # set at creation time, will be set at subscription creation time. currency: nil, # A valid customer email, to be used for invoicing and notifications. email: nil, email_delivery: nil, # The external customer ID. This can only be set if empty and the customer has no - # past or current subscriptions. + # past or current subscriptions. external_customer_id: nil, # The hierarchical relationships for this customer. hierarchy: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, # The full name of the customer name: nil, # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. payment_provider: nil, # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | tax_id: nil, request_options: {} ); end # This endpoint returns a list of all customers for an account. The list of - # customers is ordered starting from the most recently created customer. This - # endpoint follows Orb's - # [standardized pagination format](/api-reference/pagination). + # customers is ordered starting from the most recently created customer. This + # endpoint follows Orb's + # [standardized pagination format](/api-reference/pagination). # - # See [Customer](/core-concepts##customer) for an overview of the customer model. + # See [Customer](/core-concepts##customer) for an overview of the customer model. sig do params( created_at_gt: T.nilable(Time), @@ -415,27 +415,27 @@ module Orb created_at_lt: nil, created_at_lte: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} ); end # This performs a deletion of this customer, its subscriptions, and its invoices, - # provided the customer does not have any issued invoices. Customers with issued - # invoices cannot be deleted. This operation is irreversible. Note that this is a - # _soft_ deletion, but the data will be inaccessible through the API and Orb - # dashboard. + # provided the customer does not have any issued invoices. Customers with issued + # invoices cannot be deleted. This operation is irreversible. Note that this is a + # _soft_ deletion, but the data will be inaccessible through the API and Orb + # dashboard. # - # For a hard-deletion, please reach out to the Orb team directly. + # For a hard-deletion, please reach out to the Orb team directly. # - # **Note**: This operation happens asynchronously and can be expected to take a - # few minutes to propagate to related resources. However, querying for the - # customer on subsequent GET requests while deletion is in process will reflect - # its deletion with a `deleted: true` property. Once the customer deletion has - # been fully processed, the customer will not be returned in the API. + # **Note**: This operation happens asynchronously and can be expected to take a + # few minutes to propagate to related resources. However, querying for the + # customer on subsequent GET requests while deletion is in process will reflect + # its deletion with a `deleted: true` property. Once the customer deletion has + # been fully processed, the customer will not be returned in the API. # - # On successful processing, this returns an empty dictionary (`{}`) in the API. + # On successful processing, this returns an empty dictionary (`{}`) in the API. sig do params( customer_id: String, @@ -446,11 +446,11 @@ module Orb def delete(customer_id, request_options: {}); end # This endpoint is used to fetch customer details given an identifier. If the - # `Customer` is in the process of being deleted, only the properties `id` and - # `deleted: true` will be returned. + # `Customer` is in the process of being deleted, only the properties `id` and + # `deleted: true` will be returned. # - # See the [Customer resource](/core-concepts#customer) for a full discussion of - # the Customer model. + # See the [Customer resource](/core-concepts#customer) for a full discussion of + # the Customer model. sig do params( customer_id: String, @@ -461,10 +461,10 @@ module Orb def fetch(customer_id, request_options: {}); end # This endpoint is used to fetch customer details given an `external_customer_id` - # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). + # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). # - # Note that the resource and semantics of this endpoint exactly mirror - # [Get Customer](fetch-customer). + # Note that the resource and semantics of this endpoint exactly mirror + # [Get Customer](fetch-customer). sig do params( external_customer_id: String, @@ -476,10 +476,10 @@ module Orb # Sync Orb's payment methods for the customer with their gateway. # - # This method can be called before taking an action that may cause the customer to - # be charged, ensuring that the most up-to-date payment method is charged. + # This method can be called before taking an action that may cause the customer to + # be charged, ensuring that the most up-to-date payment method is charged. # - # **Note**: This functionality is currently only available for Stripe. + # **Note**: This functionality is currently only available for Stripe. sig do params( external_customer_id: String, @@ -491,10 +491,10 @@ module Orb # Sync Orb's payment methods for the customer with their gateway. # - # This method can be called before taking an action that may cause the customer to - # be charged, ensuring that the most up-to-date payment method is charged. + # This method can be called before taking an action that may cause the customer to + # be charged, ensuring that the most up-to-date payment method is charged. # - # **Note**: This functionality is currently only available for Stripe. + # **Note**: This functionality is currently only available for Stripe. sig do params( customer_id: String, @@ -505,9 +505,9 @@ module Orb def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, request_options: {}); end # This endpoint is used to update customer details given an `external_customer_id` - # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the - # resource and semantics of this endpoint exactly mirror - # [Update Customer](update-customer). + # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the + # resource and semantics of this endpoint exactly mirror + # [Update Customer](update-customer). sig do params( id: String, @@ -546,149 +546,149 @@ module Orb id, accounting_sync_configuration: nil, # Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. + # addresses will be CC'd for customer communications. additional_emails: nil, # Used to determine if invoices for this customer will automatically attempt to - # charge a saved payment method, if available. This parameter defaults to `True` - # when a payment provider is provided on customer creation. + # charge a saved payment method, if available. This parameter defaults to `True` + # when a payment provider is provided on customer creation. auto_collection: nil, billing_address: nil, # An ISO 4217 currency string used for the customer's invoices and balance. If not - # set at creation time, will be set at subscription creation time. + # set at creation time, will be set at subscription creation time. currency: nil, # A valid customer email, to be used for invoicing and notifications. email: nil, email_delivery: nil, # The external customer ID. This can only be set if empty and the customer has no - # past or current subscriptions. + # past or current subscriptions. external_customer_id: nil, # The hierarchical relationships for this customer. hierarchy: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, # The full name of the customer name: nil, # This is used for creating charges or invoices in an external system via Orb. - # When not in test mode: + # When not in test mode: # - # - the connection must first be configured in the Orb webapp. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. + # - the connection must first be configured in the Orb webapp. + # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, + # `bill.com`, `netsuite`), any product mappings must first be configured with + # the Orb team. payment_provider: nil, # The ID of this customer in an external payments solution, such as Stripe. This - # is used for creating charges or invoices in the external system via Orb. + # is used for creating charges or invoices in the external system via Orb. payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, # Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. + # added to the headers of invoices. # - # ### Supported Tax ID Countries and Types + # ### Supported Tax ID Countries and Types # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | + # | Country | Type | Description | + # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | + # | Andorra | `ad_nrt` | Andorran NRT Number | + # | Argentina | `ar_cuit` | Argentinian Tax ID Number | + # | Australia | `au_abn` | Australian Business Number (AU ABN) | + # | Australia | `au_arn` | Australian Taxation Office Reference Number | + # | Austria | `eu_vat` | European VAT Number | + # | Bahrain | `bh_vat` | Bahraini VAT Number | + # | Belgium | `eu_vat` | European VAT Number | + # | Bolivia | `bo_tin` | Bolivian Tax ID | + # | Brazil | `br_cnpj` | Brazilian CNPJ Number | + # | Brazil | `br_cpf` | Brazilian CPF Number | + # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | + # | Bulgaria | `eu_vat` | European VAT Number | + # | Canada | `ca_bn` | Canadian BN | + # | Canada | `ca_gst_hst` | Canadian GST/HST Number | + # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | + # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | + # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | + # | Canada | `ca_qst` | Canadian QST Number (Québec) | + # | Chile | `cl_tin` | Chilean TIN | + # | China | `cn_tin` | Chinese Tax ID | + # | Colombia | `co_nit` | Colombian NIT Number | + # | Costa Rica | `cr_tin` | Costa Rican Tax ID | + # | Croatia | `eu_vat` | European VAT Number | + # | Cyprus | `eu_vat` | European VAT Number | + # | Czech Republic | `eu_vat` | European VAT Number | + # | Denmark | `eu_vat` | European VAT Number | + # | Dominican Republic | `do_rcn` | Dominican RCN Number | + # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | + # | Egypt | `eg_tin` | Egyptian Tax Identification Number | + # | El Salvador | `sv_nit` | El Salvadorian NIT Number | + # | Estonia | `eu_vat` | European VAT Number | + # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | + # | Finland | `eu_vat` | European VAT Number | + # | France | `eu_vat` | European VAT Number | + # | Georgia | `ge_vat` | Georgian VAT | + # | Germany | `eu_vat` | European VAT Number | + # | Greece | `eu_vat` | European VAT Number | + # | Hong Kong | `hk_br` | Hong Kong BR Number | + # | Hungary | `eu_vat` | European VAT Number | + # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | + # | Iceland | `is_vat` | Icelandic VAT | + # | India | `in_gst` | Indian GST Number | + # | Indonesia | `id_npwp` | Indonesian NPWP Number | + # | Ireland | `eu_vat` | European VAT Number | + # | Israel | `il_vat` | Israel VAT | + # | Italy | `eu_vat` | European VAT Number | + # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | + # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | + # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | + # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | + # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | + # | Latvia | `eu_vat` | European VAT Number | + # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | + # | Lithuania | `eu_vat` | European VAT Number | + # | Luxembourg | `eu_vat` | European VAT Number | + # | Malaysia | `my_frp` | Malaysian FRP Number | + # | Malaysia | `my_itn` | Malaysian ITN | + # | Malaysia | `my_sst` | Malaysian SST Number | + # | Malta | `eu_vat ` | European VAT Number | + # | Mexico | `mx_rfc` | Mexican RFC Number | + # | Netherlands | `eu_vat` | European VAT Number | + # | New Zealand | `nz_gst` | New Zealand GST Number | + # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | + # | Norway | `no_vat` | Norwegian VAT Number | + # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | + # | Oman | `om_vat` | Omani VAT Number | + # | Peru | `pe_ruc` | Peruvian RUC Number | + # | Philippines | `ph_tin ` | Philippines Tax Identification Number | + # | Poland | `eu_vat` | European VAT Number | + # | Portugal | `eu_vat` | European VAT Number | + # | Romania | `eu_vat` | European VAT Number | + # | Romania | `ro_tin` | Romanian Tax ID Number | + # | Russia | `ru_inn` | Russian INN | + # | Russia | `ru_kpp` | Russian KPP | + # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | + # | Serbia | `rs_pib` | Serbian PIB Number | + # | Singapore | `sg_gst` | Singaporean GST | + # | Singapore | `sg_uen` | Singaporean UEN | + # | Slovakia | `eu_vat` | European VAT Number | + # | Slovenia | `eu_vat` | European VAT Number | + # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | + # | South Africa | `za_vat` | South African VAT Number | + # | South Korea | `kr_brn` | Korean BRN | + # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | + # | Spain | `eu_vat` | European VAT Number | + # | Sweden | `eu_vat` | European VAT Number | + # | Switzerland | `ch_vat` | Switzerland VAT Number | + # | Taiwan | `tw_vat` | Taiwanese VAT | + # | Thailand | `th_vat` | Thai VAT | + # | Turkey | `tr_tin` | Turkish Tax Identification Number | + # | Ukraine | `ua_vat` | Ukrainian VAT | + # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | + # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | + # | United Kingdom | `gb_vat` | United Kingdom VAT Number | + # | United States | `us_ein` | United States EIN | + # | Uruguay | `uy_ruc` | Uruguayan RUC Number | + # | Venezuela | `ve_rif` | Venezuelan RIF Number | + # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | tax_id: nil, request_options: {} ); end diff --git a/rbi/lib/orb/resources/customers/balance_transactions.rbi b/rbi/lib/orb/resources/customers/balance_transactions.rbi index 8a5a0b8b..67ccb779 100644 --- a/rbi/lib/orb/resources/customers/balance_transactions.rbi +++ b/rbi/lib/orb/resources/customers/balance_transactions.rbi @@ -5,7 +5,7 @@ module Orb class Customers class BalanceTransactions # Creates an immutable balance transaction that updates the customer's balance and - # returns back the newly created transaction. + # returns back the newly created transaction. sig do params( customer_id: String, @@ -26,32 +26,32 @@ module Orb ); end # ## The customer balance # - # The customer balance is an amount in the customer's currency, which Orb - # automatically applies to subsequent invoices. This balance can be adjusted - # manually via Orb's webapp on the customer details page. You can use this balance - # to provide a fixed mid-period credit to the customer. Commonly, this is done due - # to system downtime/SLA violation, or an adhoc adjustment discussed with the - # customer. + # The customer balance is an amount in the customer's currency, which Orb + # automatically applies to subsequent invoices. This balance can be adjusted + # manually via Orb's webapp on the customer details page. You can use this balance + # to provide a fixed mid-period credit to the customer. Commonly, this is done due + # to system downtime/SLA violation, or an adhoc adjustment discussed with the + # customer. # - # If the balance is a positive value at the time of invoicing, it represents that - # the customer has credit that should be used to offset the amount due on the next - # issued invoice. In this case, Orb will automatically reduce the next invoice by - # the balance amount, and roll over any remaining balance if the invoice is fully - # discounted. + # If the balance is a positive value at the time of invoicing, it represents that + # the customer has credit that should be used to offset the amount due on the next + # issued invoice. In this case, Orb will automatically reduce the next invoice by + # the balance amount, and roll over any remaining balance if the invoice is fully + # discounted. # - # If the balance is a negative value at the time of invoicing, Orb will increase - # the invoice's amount due with a positive adjustment, and reset the balance to 0. + # If the balance is a negative value at the time of invoicing, Orb will increase + # the invoice's amount due with a positive adjustment, and reset the balance to 0. # - # This endpoint retrieves all customer balance transactions in reverse - # chronological order for a single customer, providing a complete audit trail of - # all adjustments and invoice applications. + # This endpoint retrieves all customer balance transactions in reverse + # chronological order for a single customer, providing a complete audit trail of + # all adjustments and invoice applications. # - # ## Eligibility + # ## Eligibility # - # The customer balance can only be applied to invoices or adjusted manually if - # invoices are not synced to a separate invoicing provider. If a payment gateway - # such as Stripe is used, the balance will be applied to the invoice before - # forwarding payment to the gateway. + # The customer balance can only be applied to invoices or adjusted manually if + # invoices are not synced to a separate invoicing provider. If a payment gateway + # such as Stripe is used, the balance will be applied to the invoice before + # forwarding payment to the gateway. sig do params( customer_id: String, @@ -68,7 +68,7 @@ module Orb def list( customer_id, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, diff --git a/rbi/lib/orb/resources/customers/costs.rbi b/rbi/lib/orb/resources/customers/costs.rbi index 7add89ad..f1f5a172 100644 --- a/rbi/lib/orb/resources/customers/costs.rbi +++ b/rbi/lib/orb/resources/customers/costs.rbi @@ -5,122 +5,122 @@ module Orb class Customers class Costs # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in - # Orb, calculated by applying pricing information to the underlying usage (see the - # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) - # to fetch usage per metric, in usage units rather than a currency). - # - # This endpoint can be leveraged for internal tooling and to provide a more - # transparent billing experience for your end users: - # - # 1. Understand the cost breakdown per line item historically and in real-time for - # the current billing period. - # 2. Provide customer visibility into how different services are contributing to - # the overall invoice with a per-day timeseries (as compared to the - # [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource, - # which represents a snapshot for the current period). - # 3. Assess how minimums and discounts affect your customers by teasing apart - # costs directly as a result of usage, as opposed to minimums and discounts at - # the plan and price level. - # 4. Gain insight into key customer health metrics, such as the percent - # utilization of the minimum committed spend. - # - # ## Fetching subscriptions - # - # By default, this endpoint fetches the currently active subscription for the - # customer, and returns cost information for the subscription's current billing - # period, broken down by each participating price. If there are no currently - # active subscriptions, this will instead default to the most recently active - # subscription or return an empty series if none are found. For example, if your - # plan charges for compute hours, job runs, and data syncs, then this endpoint - # would provide a daily breakdown of your customer's cost for each of those axes. - # - # If timeframe bounds are specified, Orb fetches all subscriptions that were - # active in that timeframe. If two subscriptions overlap on a single day, costs - # from each price will be summed, and prices for both subscriptions will be - # included in the breakdown. - # - # ## Prepaid plans - # - # For plans that include prices which deduct credits rather than accrue in-arrears - # charges in a billable currency, this endpoint will return the total deduction - # amount, in credits, for the specified timeframe. - # - # ## Cumulative subtotals and totals - # - # Since the subtotal and total must factor in any billing-period level discounts - # and minimums, it's most meaningful to consider costs relative to the start of - # the subscription's billing period. As a result, by default this endpoint returns - # cumulative totals since the beginning of the billing period. In particular, the - # `timeframe_start` of a returned timeframe window is _always_ the beginning of - # the billing period and `timeframe_end` is incremented one day at a time to build - # the result. - # - # A customer that uses a few API calls a day but has a minimum commitment might - # exhibit the following pattern for their subtotal and total in the first few days - # of the month. Here, we assume that each API call is $2.50, the customer's plan - # has a monthly minimum of $50 for this price, and that the subscription's billing - # period bounds are aligned to the first of the month: - # - # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) | - # | --------------- | ------------- | ---------------- | -------- | ------------------------ | - # | 2023-02-01 | 2023-02-02 | 9 | $22.50 | $50.00 | - # | 2023-02-01 | 2023-02-03 | 19 | $47.50 | $50.00 | - # | 2023-02-01 | 2023-02-04 | 20 | $50.00 | $50.00 | - # | 2023-02-01 | 2023-02-05 | 28 | $70.00 | $70.00 | - # | 2023-02-01 | 2023-02-06 | 36 | $90.00 | $90.00 | - # - # ### Periodic values - # - # When the query parameter `view_mode=periodic` is specified, Orb will return an - # incremental day-by-day view of costs. In this case, there will always be a - # one-day difference between `timeframe_start` and `timeframe_end` for the - # timeframes returned. This is a transform on top of the cumulative costs, - # calculated by taking the difference of each timeframe with the last. Note that - # in the above example, the `Total` value would be 0 for the second two data - # points, since the minimum commitment has not yet been hit and each day is not - # contributing anything to the total cost. - # - # ## Timeframe bounds - # - # For an active subscription, both timeframes should be specified in the request. - # If a subscription starts or ends within the timeframe, the response will only - # include windows where the subscription is active. If a subscription has ended, - # no timeframe bounds need to be specified and the response will default to the - # billing period when the subscription was last active. - # - # As noted above, `timeframe_start` for a given cumulative datapoint is always the - # beginning of the billing period, and `timeframe_end` is incremented one day at a - # time to construct the response. When a timeframe is passed in that is not - # aligned to the current subscription's billing period, the response will contain - # cumulative totals from multiple billing periods. - # - # Suppose the queried customer has a subscription aligned to the 15th of every - # month. If this endpoint is queried with the date range `2023-06-01` - - # `2023-07-01`, the first data point will represent about half a billing period's - # worth of costs, accounting for accruals from the start of the billing period and - # inclusive of the first day of the timeframe - # (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`) - # - # | datapoint index | timeframe_start | timeframe_end | - # | --------------- | --------------- | ------------- | - # | 0 | 2023-05-15 | 2023-06-02 | - # | 1 | 2023-05-15 | 2023-06-03 | - # | 2 | ... | ... | - # | 3 | 2023-05-15 | 2023-06-14 | - # | 4 | 2023-06-15 | 2023-06-16 | - # | 5 | 2023-06-15 | 2023-06-17 | - # | 6 | ... | ... | - # | 7 | 2023-06-15 | 2023-07-01 | - # - # You can see this sliced timeframe visualized - # [here](https://i.imgur.com/TXhYgme.png). - # - # ### Matrix prices - # - # When a price uses matrix pricing, it's important to view costs grouped by those - # matrix dimensions. Orb will return `price_groups` with the `grouping_key` and - # `secondary_grouping_key` based on the matrix price definition, for each - # `grouping_value` and `secondary_grouping_value` available. + # Orb, calculated by applying pricing information to the underlying usage (see the + # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) + # to fetch usage per metric, in usage units rather than a currency). + # + # This endpoint can be leveraged for internal tooling and to provide a more + # transparent billing experience for your end users: + # + # 1. Understand the cost breakdown per line item historically and in real-time for + # the current billing period. + # 2. Provide customer visibility into how different services are contributing to + # the overall invoice with a per-day timeseries (as compared to the + # [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource, + # which represents a snapshot for the current period). + # 3. Assess how minimums and discounts affect your customers by teasing apart + # costs directly as a result of usage, as opposed to minimums and discounts at + # the plan and price level. + # 4. Gain insight into key customer health metrics, such as the percent + # utilization of the minimum committed spend. + # + # ## Fetching subscriptions + # + # By default, this endpoint fetches the currently active subscription for the + # customer, and returns cost information for the subscription's current billing + # period, broken down by each participating price. If there are no currently + # active subscriptions, this will instead default to the most recently active + # subscription or return an empty series if none are found. For example, if your + # plan charges for compute hours, job runs, and data syncs, then this endpoint + # would provide a daily breakdown of your customer's cost for each of those axes. + # + # If timeframe bounds are specified, Orb fetches all subscriptions that were + # active in that timeframe. If two subscriptions overlap on a single day, costs + # from each price will be summed, and prices for both subscriptions will be + # included in the breakdown. + # + # ## Prepaid plans + # + # For plans that include prices which deduct credits rather than accrue in-arrears + # charges in a billable currency, this endpoint will return the total deduction + # amount, in credits, for the specified timeframe. + # + # ## Cumulative subtotals and totals + # + # Since the subtotal and total must factor in any billing-period level discounts + # and minimums, it's most meaningful to consider costs relative to the start of + # the subscription's billing period. As a result, by default this endpoint returns + # cumulative totals since the beginning of the billing period. In particular, the + # `timeframe_start` of a returned timeframe window is _always_ the beginning of + # the billing period and `timeframe_end` is incremented one day at a time to build + # the result. + # + # A customer that uses a few API calls a day but has a minimum commitment might + # exhibit the following pattern for their subtotal and total in the first few days + # of the month. Here, we assume that each API call is $2.50, the customer's plan + # has a monthly minimum of $50 for this price, and that the subscription's billing + # period bounds are aligned to the first of the month: + # + # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) | + # | --------------- | ------------- | ---------------- | -------- | ------------------------ | + # | 2023-02-01 | 2023-02-02 | 9 | $22.50 | $50.00 | + # | 2023-02-01 | 2023-02-03 | 19 | $47.50 | $50.00 | + # | 2023-02-01 | 2023-02-04 | 20 | $50.00 | $50.00 | + # | 2023-02-01 | 2023-02-05 | 28 | $70.00 | $70.00 | + # | 2023-02-01 | 2023-02-06 | 36 | $90.00 | $90.00 | + # + # ### Periodic values + # + # When the query parameter `view_mode=periodic` is specified, Orb will return an + # incremental day-by-day view of costs. In this case, there will always be a + # one-day difference between `timeframe_start` and `timeframe_end` for the + # timeframes returned. This is a transform on top of the cumulative costs, + # calculated by taking the difference of each timeframe with the last. Note that + # in the above example, the `Total` value would be 0 for the second two data + # points, since the minimum commitment has not yet been hit and each day is not + # contributing anything to the total cost. + # + # ## Timeframe bounds + # + # For an active subscription, both timeframes should be specified in the request. + # If a subscription starts or ends within the timeframe, the response will only + # include windows where the subscription is active. If a subscription has ended, + # no timeframe bounds need to be specified and the response will default to the + # billing period when the subscription was last active. + # + # As noted above, `timeframe_start` for a given cumulative datapoint is always the + # beginning of the billing period, and `timeframe_end` is incremented one day at a + # time to construct the response. When a timeframe is passed in that is not + # aligned to the current subscription's billing period, the response will contain + # cumulative totals from multiple billing periods. + # + # Suppose the queried customer has a subscription aligned to the 15th of every + # month. If this endpoint is queried with the date range `2023-06-01` - + # `2023-07-01`, the first data point will represent about half a billing period's + # worth of costs, accounting for accruals from the start of the billing period and + # inclusive of the first day of the timeframe + # (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`) + # + # | datapoint index | timeframe_start | timeframe_end | + # | --------------- | --------------- | ------------- | + # | 0 | 2023-05-15 | 2023-06-02 | + # | 1 | 2023-05-15 | 2023-06-03 | + # | 2 | ... | ... | + # | 3 | 2023-05-15 | 2023-06-14 | + # | 4 | 2023-06-15 | 2023-06-16 | + # | 5 | 2023-06-15 | 2023-06-17 | + # | 6 | ... | ... | + # | 7 | 2023-06-15 | 2023-07-01 | + # + # You can see this sliced timeframe visualized + # [here](https://i.imgur.com/TXhYgme.png). + # + # ### Matrix prices + # + # When a price uses matrix pricing, it's important to view costs grouped by those + # matrix dimensions. Orb will return `price_groups` with the `grouping_key` and + # `secondary_grouping_key` based on the matrix price definition, for each + # `grouping_value` and `secondary_grouping_value` available. sig do params( customer_id: String, @@ -141,129 +141,129 @@ module Orb # Costs returned are inclusive of `timeframe_start`. timeframe_start: nil, # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. view_mode: nil, request_options: {} ); end # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in - # Orb, calculated by applying pricing information to the underlying usage (see the - # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) - # to fetch usage per metric, in usage units rather than a currency). - # - # This endpoint can be leveraged for internal tooling and to provide a more - # transparent billing experience for your end users: - # - # 1. Understand the cost breakdown per line item historically and in real-time for - # the current billing period. - # 2. Provide customer visibility into how different services are contributing to - # the overall invoice with a per-day timeseries (as compared to the - # [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource, - # which represents a snapshot for the current period). - # 3. Assess how minimums and discounts affect your customers by teasing apart - # costs directly as a result of usage, as opposed to minimums and discounts at - # the plan and price level. - # 4. Gain insight into key customer health metrics, such as the percent - # utilization of the minimum committed spend. - # - # ## Fetching subscriptions - # - # By default, this endpoint fetches the currently active subscription for the - # customer, and returns cost information for the subscription's current billing - # period, broken down by each participating price. If there are no currently - # active subscriptions, this will instead default to the most recently active - # subscription or return an empty series if none are found. For example, if your - # plan charges for compute hours, job runs, and data syncs, then this endpoint - # would provide a daily breakdown of your customer's cost for each of those axes. - # - # If timeframe bounds are specified, Orb fetches all subscriptions that were - # active in that timeframe. If two subscriptions overlap on a single day, costs - # from each price will be summed, and prices for both subscriptions will be - # included in the breakdown. - # - # ## Prepaid plans - # - # For plans that include prices which deduct credits rather than accrue in-arrears - # charges in a billable currency, this endpoint will return the total deduction - # amount, in credits, for the specified timeframe. - # - # ## Cumulative subtotals and totals - # - # Since the subtotal and total must factor in any billing-period level discounts - # and minimums, it's most meaningful to consider costs relative to the start of - # the subscription's billing period. As a result, by default this endpoint returns - # cumulative totals since the beginning of the billing period. In particular, the - # `timeframe_start` of a returned timeframe window is _always_ the beginning of - # the billing period and `timeframe_end` is incremented one day at a time to build - # the result. - # - # A customer that uses a few API calls a day but has a minimum commitment might - # exhibit the following pattern for their subtotal and total in the first few days - # of the month. Here, we assume that each API call is $2.50, the customer's plan - # has a monthly minimum of $50 for this price, and that the subscription's billing - # period bounds are aligned to the first of the month: - # - # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) | - # | --------------- | ------------- | ---------------- | -------- | ------------------------ | - # | 2023-02-01 | 2023-02-02 | 9 | $22.50 | $50.00 | - # | 2023-02-01 | 2023-02-03 | 19 | $47.50 | $50.00 | - # | 2023-02-01 | 2023-02-04 | 20 | $50.00 | $50.00 | - # | 2023-02-01 | 2023-02-05 | 28 | $70.00 | $70.00 | - # | 2023-02-01 | 2023-02-06 | 36 | $90.00 | $90.00 | - # - # ### Periodic values - # - # When the query parameter `view_mode=periodic` is specified, Orb will return an - # incremental day-by-day view of costs. In this case, there will always be a - # one-day difference between `timeframe_start` and `timeframe_end` for the - # timeframes returned. This is a transform on top of the cumulative costs, - # calculated by taking the difference of each timeframe with the last. Note that - # in the above example, the `Total` value would be 0 for the second two data - # points, since the minimum commitment has not yet been hit and each day is not - # contributing anything to the total cost. - # - # ## Timeframe bounds - # - # For an active subscription, both timeframes should be specified in the request. - # If a subscription starts or ends within the timeframe, the response will only - # include windows where the subscription is active. If a subscription has ended, - # no timeframe bounds need to be specified and the response will default to the - # billing period when the subscription was last active. - # - # As noted above, `timeframe_start` for a given cumulative datapoint is always the - # beginning of the billing period, and `timeframe_end` is incremented one day at a - # time to construct the response. When a timeframe is passed in that is not - # aligned to the current subscription's billing period, the response will contain - # cumulative totals from multiple billing periods. - # - # Suppose the queried customer has a subscription aligned to the 15th of every - # month. If this endpoint is queried with the date range `2023-06-01` - - # `2023-07-01`, the first data point will represent about half a billing period's - # worth of costs, accounting for accruals from the start of the billing period and - # inclusive of the first day of the timeframe - # (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`) - # - # | datapoint index | timeframe_start | timeframe_end | - # | --------------- | --------------- | ------------- | - # | 0 | 2023-05-15 | 2023-06-02 | - # | 1 | 2023-05-15 | 2023-06-03 | - # | 2 | ... | ... | - # | 3 | 2023-05-15 | 2023-06-14 | - # | 4 | 2023-06-15 | 2023-06-16 | - # | 5 | 2023-06-15 | 2023-06-17 | - # | 6 | ... | ... | - # | 7 | 2023-06-15 | 2023-07-01 | - # - # You can see this sliced timeframe visualized - # [here](https://i.imgur.com/TXhYgme.png). - # - # ### Matrix prices - # - # When a price uses matrix pricing, it's important to view costs grouped by those - # matrix dimensions. Orb will return `price_groups` with the `grouping_key` and - # `secondary_grouping_key` based on the matrix price definition, for each - # `grouping_value` and `secondary_grouping_value` available. + # Orb, calculated by applying pricing information to the underlying usage (see the + # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage) + # to fetch usage per metric, in usage units rather than a currency). + # + # This endpoint can be leveraged for internal tooling and to provide a more + # transparent billing experience for your end users: + # + # 1. Understand the cost breakdown per line item historically and in real-time for + # the current billing period. + # 2. Provide customer visibility into how different services are contributing to + # the overall invoice with a per-day timeseries (as compared to the + # [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource, + # which represents a snapshot for the current period). + # 3. Assess how minimums and discounts affect your customers by teasing apart + # costs directly as a result of usage, as opposed to minimums and discounts at + # the plan and price level. + # 4. Gain insight into key customer health metrics, such as the percent + # utilization of the minimum committed spend. + # + # ## Fetching subscriptions + # + # By default, this endpoint fetches the currently active subscription for the + # customer, and returns cost information for the subscription's current billing + # period, broken down by each participating price. If there are no currently + # active subscriptions, this will instead default to the most recently active + # subscription or return an empty series if none are found. For example, if your + # plan charges for compute hours, job runs, and data syncs, then this endpoint + # would provide a daily breakdown of your customer's cost for each of those axes. + # + # If timeframe bounds are specified, Orb fetches all subscriptions that were + # active in that timeframe. If two subscriptions overlap on a single day, costs + # from each price will be summed, and prices for both subscriptions will be + # included in the breakdown. + # + # ## Prepaid plans + # + # For plans that include prices which deduct credits rather than accrue in-arrears + # charges in a billable currency, this endpoint will return the total deduction + # amount, in credits, for the specified timeframe. + # + # ## Cumulative subtotals and totals + # + # Since the subtotal and total must factor in any billing-period level discounts + # and minimums, it's most meaningful to consider costs relative to the start of + # the subscription's billing period. As a result, by default this endpoint returns + # cumulative totals since the beginning of the billing period. In particular, the + # `timeframe_start` of a returned timeframe window is _always_ the beginning of + # the billing period and `timeframe_end` is incremented one day at a time to build + # the result. + # + # A customer that uses a few API calls a day but has a minimum commitment might + # exhibit the following pattern for their subtotal and total in the first few days + # of the month. Here, we assume that each API call is $2.50, the customer's plan + # has a monthly minimum of $50 for this price, and that the subscription's billing + # period bounds are aligned to the first of the month: + # + # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) | + # | --------------- | ------------- | ---------------- | -------- | ------------------------ | + # | 2023-02-01 | 2023-02-02 | 9 | $22.50 | $50.00 | + # | 2023-02-01 | 2023-02-03 | 19 | $47.50 | $50.00 | + # | 2023-02-01 | 2023-02-04 | 20 | $50.00 | $50.00 | + # | 2023-02-01 | 2023-02-05 | 28 | $70.00 | $70.00 | + # | 2023-02-01 | 2023-02-06 | 36 | $90.00 | $90.00 | + # + # ### Periodic values + # + # When the query parameter `view_mode=periodic` is specified, Orb will return an + # incremental day-by-day view of costs. In this case, there will always be a + # one-day difference between `timeframe_start` and `timeframe_end` for the + # timeframes returned. This is a transform on top of the cumulative costs, + # calculated by taking the difference of each timeframe with the last. Note that + # in the above example, the `Total` value would be 0 for the second two data + # points, since the minimum commitment has not yet been hit and each day is not + # contributing anything to the total cost. + # + # ## Timeframe bounds + # + # For an active subscription, both timeframes should be specified in the request. + # If a subscription starts or ends within the timeframe, the response will only + # include windows where the subscription is active. If a subscription has ended, + # no timeframe bounds need to be specified and the response will default to the + # billing period when the subscription was last active. + # + # As noted above, `timeframe_start` for a given cumulative datapoint is always the + # beginning of the billing period, and `timeframe_end` is incremented one day at a + # time to construct the response. When a timeframe is passed in that is not + # aligned to the current subscription's billing period, the response will contain + # cumulative totals from multiple billing periods. + # + # Suppose the queried customer has a subscription aligned to the 15th of every + # month. If this endpoint is queried with the date range `2023-06-01` - + # `2023-07-01`, the first data point will represent about half a billing period's + # worth of costs, accounting for accruals from the start of the billing period and + # inclusive of the first day of the timeframe + # (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`) + # + # | datapoint index | timeframe_start | timeframe_end | + # | --------------- | --------------- | ------------- | + # | 0 | 2023-05-15 | 2023-06-02 | + # | 1 | 2023-05-15 | 2023-06-03 | + # | 2 | ... | ... | + # | 3 | 2023-05-15 | 2023-06-14 | + # | 4 | 2023-06-15 | 2023-06-16 | + # | 5 | 2023-06-15 | 2023-06-17 | + # | 6 | ... | ... | + # | 7 | 2023-06-15 | 2023-07-01 | + # + # You can see this sliced timeframe visualized + # [here](https://i.imgur.com/TXhYgme.png). + # + # ### Matrix prices + # + # When a price uses matrix pricing, it's important to view costs grouped by those + # matrix dimensions. Orb will return `price_groups` with the `grouping_key` and + # `secondary_grouping_key` based on the matrix price definition, for each + # `grouping_value` and `secondary_grouping_value` available. sig do params( external_customer_id: String, @@ -284,9 +284,9 @@ module Orb # Costs returned are inclusive of `timeframe_start`. timeframe_start: nil, # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. view_mode: nil, request_options: {} ); end diff --git a/rbi/lib/orb/resources/customers/credits.rbi b/rbi/lib/orb/resources/customers/credits.rbi index 0e527c72..7d8f16f6 100644 --- a/rbi/lib/orb/resources/customers/credits.rbi +++ b/rbi/lib/orb/resources/customers/credits.rbi @@ -12,11 +12,11 @@ module Orb # Returns a paginated list of unexpired, non-zero credit blocks for a customer. # - # If `include_all_blocks` is set to `true`, all credit blocks (including expired - # and depleted blocks) will be included in the response. + # If `include_all_blocks` is set to `true`, all credit blocks (including expired + # and depleted blocks) will be included in the response. # - # Note that `currency` defaults to credits if not specified. To use a real world - # currency, set `currency` to an ISO 4217 string. + # Note that `currency` defaults to credits if not specified. To use a real world + # currency, set `currency` to an ISO 4217 string. sig do params( customer_id: String, @@ -33,10 +33,10 @@ module Orb # The ledger currency or custom pricing unit to use. currency: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # If set to True, all expired and depleted blocks, as well as active block will be - # returned. + # returned. include_all_blocks: nil, # The number of items to fetch. Defaults to 20. limit: nil, @@ -44,11 +44,11 @@ module Orb ); end # Returns a paginated list of unexpired, non-zero credit blocks for a customer. # - # If `include_all_blocks` is set to `true`, all credit blocks (including expired - # and depleted blocks) will be included in the response. + # If `include_all_blocks` is set to `true`, all credit blocks (including expired + # and depleted blocks) will be included in the response. # - # Note that `currency` defaults to credits if not specified. To use a real world - # currency, set `currency` to an ISO 4217 string. + # Note that `currency` defaults to credits if not specified. To use a real world + # currency, set `currency` to an ISO 4217 string. sig do params( external_customer_id: String, @@ -65,10 +65,10 @@ module Orb # The ledger currency or custom pricing unit to use. currency: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # If set to True, all expired and depleted blocks, as well as active block will be - # returned. + # returned. include_all_blocks: nil, # The number of items to fetch. Defaults to 20. limit: nil, diff --git a/rbi/lib/orb/resources/customers/credits/ledger.rbi b/rbi/lib/orb/resources/customers/credits/ledger.rbi index 5b32f081..78b3fdd6 100644 --- a/rbi/lib/orb/resources/customers/credits/ledger.rbi +++ b/rbi/lib/orb/resources/customers/credits/ledger.rbi @@ -6,86 +6,86 @@ module Orb class Credits class Ledger # The credits ledger provides _auditing_ functionality over Orb's credits system - # with a list of actions that have taken place to modify a customer's credit - # balance. This [paginated endpoint](/api-reference/pagination) lists these - # entries, starting from the most recent ledger entry. + # with a list of actions that have taken place to modify a customer's credit + # balance. This [paginated endpoint](/api-reference/pagination) lists these + # entries, starting from the most recent ledger entry. # - # More details on using Orb's real-time credit feature are - # [here](/product-catalog/prepurchase). + # More details on using Orb's real-time credit feature are + # [here](/product-catalog/prepurchase). # - # There are four major types of modifications to credit balance, detailed below. + # There are four major types of modifications to credit balance, detailed below. # - # ## Increment + # ## Increment # - # Credits (which optionally expire on a future date) can be added via the API - # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action - # will always contain the total eligible starting and ending balance for the - # customer at the time the entry was added to the ledger. + # Credits (which optionally expire on a future date) can be added via the API + # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action + # will always contain the total eligible starting and ending balance for the + # customer at the time the entry was added to the ledger. # - # ## Decrement + # ## Decrement # - # Deductions can occur as a result of an API call to create a ledger entry (see - # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of - # incurring usage. Both ledger entries present the `decrement` entry type. + # Deductions can occur as a result of an API call to create a ledger entry (see + # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of + # incurring usage. Both ledger entries present the `decrement` entry type. # - # As usage for a customer is reported into Orb, credits may be deducted according - # to the customer's plan configuration. An automated deduction of this type will - # result in a ledger entry, also with a starting and ending balance. In order to - # provide better tracing capabilities for automatic deductions, Orb always - # associates each automatic deduction with the `event_id` at the time of - # ingestion, used to pinpoint _why_ credit deduction took place and to ensure that - # credits are never deducted without an associated usage event. + # As usage for a customer is reported into Orb, credits may be deducted according + # to the customer's plan configuration. An automated deduction of this type will + # result in a ledger entry, also with a starting and ending balance. In order to + # provide better tracing capabilities for automatic deductions, Orb always + # associates each automatic deduction with the `event_id` at the time of + # ingestion, used to pinpoint _why_ credit deduction took place and to ensure that + # credits are never deducted without an associated usage event. # - # By default, Orb uses an algorithm that automatically deducts from the _soonest - # expiring credit block_ first in order to ensure that all credits are utilized - # appropriately. As an example, if trial credits with an expiration date of 2 - # weeks from now are present for a customer, they will be used before any - # deductions take place from a non-expiring credit block. + # By default, Orb uses an algorithm that automatically deducts from the _soonest + # expiring credit block_ first in order to ensure that all credits are utilized + # appropriately. As an example, if trial credits with an expiration date of 2 + # weeks from now are present for a customer, they will be used before any + # deductions take place from a non-expiring credit block. # - # If there are multiple blocks with the same expiration date, Orb will deduct from - # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost - # basis before paid credits with a $5.00 cost basis). + # If there are multiple blocks with the same expiration date, Orb will deduct from + # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost + # basis before paid credits with a $5.00 cost basis). # - # It's also possible for a single usage event's deduction to _span_ credit blocks. - # In this case, Orb will deduct from the next block, ending at the credit block - # which consists of unexpiring credits. Each of these deductions will lead to a - # _separate_ ledger entry, one per credit block that is deducted from. By default, - # the customer's total credit balance in Orb can be negative as a result of a - # decrement. + # It's also possible for a single usage event's deduction to _span_ credit blocks. + # In this case, Orb will deduct from the next block, ending at the credit block + # which consists of unexpiring credits. Each of these deductions will lead to a + # _separate_ ledger entry, one per credit block that is deducted from. By default, + # the customer's total credit balance in Orb can be negative as a result of a + # decrement. # - # ## Expiration change + # ## Expiration change # - # The expiry of credits can be changed as a result of the API (See - # [Add Ledger Entry](create-ledger-entry)). This will create a ledger entry that - # specifies the balance as well as the initial and target expiry dates. + # The expiry of credits can be changed as a result of the API (See + # [Add Ledger Entry](create-ledger-entry)). This will create a ledger entry that + # specifies the balance as well as the initial and target expiry dates. # - # Note that for this entry type, `starting_balance` will equal `ending_balance`, - # and the `amount` represents the balance transferred. The credit block linked to - # the ledger entry is the source credit block from which there was an expiration - # change + # Note that for this entry type, `starting_balance` will equal `ending_balance`, + # and the `amount` represents the balance transferred. The credit block linked to + # the ledger entry is the source credit block from which there was an expiration + # change # - # ## Credits expiry + # ## Credits expiry # - # When a set of credits expire on pre-set expiration date, the customer's balance - # automatically reflects this change and adds an entry to the ledger indicating - # this event. Note that credit expiry should always happen close to a date - # boundary in the customer's timezone. + # When a set of credits expire on pre-set expiration date, the customer's balance + # automatically reflects this change and adds an entry to the ledger indicating + # this event. Note that credit expiry should always happen close to a date + # boundary in the customer's timezone. # - # ## Void initiated + # ## Void initiated # - # Credit blocks can be voided via the API. The `amount` on this entry corresponds - # to the number of credits that were remaining in the block at time of void. - # `void_reason` will be populated if the void is created with a reason. + # Credit blocks can be voided via the API. The `amount` on this entry corresponds + # to the number of credits that were remaining in the block at time of void. + # `void_reason` will be populated if the void is created with a reason. # - # ## Void + # ## Void # - # When a set of credits is voided, the customer's balance automatically reflects - # this change and adds an entry to the ledger indicating this event. + # When a set of credits is voided, the customer's balance automatically reflects + # this change and adds an entry to the ledger indicating this event. # - # ## Amendment + # ## Amendment # - # When credits are added to a customer's balance as a result of a correction, this - # entry will be added to the ledger to indicate the adjustment of credits. + # When credits are added to a customer's balance as a result of a correction, this + # entry will be added to the ledger to indicate the adjustment of credits. sig do params( customer_id: String, @@ -124,7 +124,7 @@ module Orb # The ledger currency or custom pricing unit to use. currency: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, entry_status: nil, entry_type: nil, @@ -134,115 +134,115 @@ module Orb request_options: {} ); end # This endpoint allows you to create a new ledger entry for a specified customer's - # balance. This can be used to increment balance, deduct credits, and change the - # expiry date of existing credits. - # - # ## Effects of adding a ledger entry - # - # 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) - # will return a credit block that represents the changes (i.e. balance changes - # or transfers). - # 2. A ledger entry will be added to the credits ledger for this customer, and - # therefore returned in the - # [View Credits Ledger](fetch-customer-credits-ledger) response as well as - # serialized in the response to this request. In the case of deductions without - # a specified block, multiple ledger entries may be created if the deduction - # spans credit blocks. - # 3. If `invoice_settings` is specified, an invoice will be created that reflects - # the cost of the credits (based on `amount` and `per_unit_cost_basis`). - # - # ## Adding credits - # - # Adding credits is done by creating an entry of type `increment`. This requires - # the caller to specify a number of credits as well as an optional expiry date in - # `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with - # auditing. When adding credits, the caller can also specify a cost basis - # per-credit, to indicate how much in USD a customer paid for a single credit in a - # block. This can later be used for revenue recognition. - # - # The following snippet illustrates a sample request body to increment credits - # which will expire in January of 2022. - # - # ```json - # { - # "entry_type": "increment", - # "amount": 100, - # "expiry_date": "2022-12-28", - # "per_unit_cost_basis": "0.20", - # "description": "Purchased 100 credits" - # } - # ``` - # - # Note that by default, Orb will always first increment any _negative_ balance in - # existing blocks before adding the remaining amount to the desired credit block. - # - # ### Invoicing for credits - # - # By default, Orb manipulates the credit ledger but does not charge for credits. - # However, if you pass `invoice_settings` in the body of this request, Orb will - # also generate a one-off invoice for the customer for the credits pre-purchase. - # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges - # on the invoice are calculated by multiplying the cost basis with the number of - # credit units added. - # - # ## Deducting Credits - # - # Orb allows you to deduct credits from a customer by creating an entry of type - # `decrement`. Orb matches the algorithm for automatic deductions for determining - # which credit blocks to decrement from. In the case that the deduction leads to - # multiple ledger entries, the response from this endpoint will be the final - # deduction. Orb also optionally allows specifying a description to assist with - # auditing. - # - # The following snippet illustrates a sample request body to decrement credits. - # - # ```json - # { - # "entry_type": "decrement", - # "amount": 20, - # "description": "Removing excess credits" - # } - # ``` - # - # ## Changing credits expiry - # - # If you'd like to change when existing credits expire, you should create a ledger - # entry of type `expiration_change`. For this entry, the required parameter - # `expiry_date` identifies the _originating_ block, and the required parameter - # `target_expiry_date` identifies when the transferred credits should now expire. - # A new credit block will be created with expiry date `target_expiry_date`, with - # the same cost basis data as the original credit block, if present. - # - # Note that the balance of the block with the given `expiry_date` must be at least - # equal to the desired transfer amount determined by the `amount` parameter. - # - # The following snippet illustrates a sample request body to extend the expiration - # date of credits by one year: - # - # ```json - # { - # "entry_type": "expiration_change", - # "amount": 10, - # "expiry_date": "2022-12-28", - # "block_id": "UiUhFWeLHPrBY4Ad", - # "target_expiry_date": "2023-12-28", - # "description": "Extending credit validity" - # } - # ``` - # - # ## Voiding credits - # - # If you'd like to void a credit block, create a ledger entry of type `void`. For - # this entry, `block_id` is required to identify the block, and `amount` indicates - # how many credits to void, up to the block's initial balance. Pass in a - # `void_reason` of `refund` if the void is due to a refund. - # - # ## Amendment - # - # If you'd like to undo a decrement on a credit block, create a ledger entry of - # type `amendment`. For this entry, `block_id` is required to identify the block - # that was originally decremented from, and `amount` indicates how many credits to - # return to the customer, up to the block's initial balance. + # balance. This can be used to increment balance, deduct credits, and change the + # expiry date of existing credits. + # + # ## Effects of adding a ledger entry + # + # 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) + # will return a credit block that represents the changes (i.e. balance changes + # or transfers). + # 2. A ledger entry will be added to the credits ledger for this customer, and + # therefore returned in the + # [View Credits Ledger](fetch-customer-credits-ledger) response as well as + # serialized in the response to this request. In the case of deductions without + # a specified block, multiple ledger entries may be created if the deduction + # spans credit blocks. + # 3. If `invoice_settings` is specified, an invoice will be created that reflects + # the cost of the credits (based on `amount` and `per_unit_cost_basis`). + # + # ## Adding credits + # + # Adding credits is done by creating an entry of type `increment`. This requires + # the caller to specify a number of credits as well as an optional expiry date in + # `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with + # auditing. When adding credits, the caller can also specify a cost basis + # per-credit, to indicate how much in USD a customer paid for a single credit in a + # block. This can later be used for revenue recognition. + # + # The following snippet illustrates a sample request body to increment credits + # which will expire in January of 2022. + # + # ```json + # { + # "entry_type": "increment", + # "amount": 100, + # "expiry_date": "2022-12-28", + # "per_unit_cost_basis": "0.20", + # "description": "Purchased 100 credits" + # } + # ``` + # + # Note that by default, Orb will always first increment any _negative_ balance in + # existing blocks before adding the remaining amount to the desired credit block. + # + # ### Invoicing for credits + # + # By default, Orb manipulates the credit ledger but does not charge for credits. + # However, if you pass `invoice_settings` in the body of this request, Orb will + # also generate a one-off invoice for the customer for the credits pre-purchase. + # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges + # on the invoice are calculated by multiplying the cost basis with the number of + # credit units added. + # + # ## Deducting Credits + # + # Orb allows you to deduct credits from a customer by creating an entry of type + # `decrement`. Orb matches the algorithm for automatic deductions for determining + # which credit blocks to decrement from. In the case that the deduction leads to + # multiple ledger entries, the response from this endpoint will be the final + # deduction. Orb also optionally allows specifying a description to assist with + # auditing. + # + # The following snippet illustrates a sample request body to decrement credits. + # + # ```json + # { + # "entry_type": "decrement", + # "amount": 20, + # "description": "Removing excess credits" + # } + # ``` + # + # ## Changing credits expiry + # + # If you'd like to change when existing credits expire, you should create a ledger + # entry of type `expiration_change`. For this entry, the required parameter + # `expiry_date` identifies the _originating_ block, and the required parameter + # `target_expiry_date` identifies when the transferred credits should now expire. + # A new credit block will be created with expiry date `target_expiry_date`, with + # the same cost basis data as the original credit block, if present. + # + # Note that the balance of the block with the given `expiry_date` must be at least + # equal to the desired transfer amount determined by the `amount` parameter. + # + # The following snippet illustrates a sample request body to extend the expiration + # date of credits by one year: + # + # ```json + # { + # "entry_type": "expiration_change", + # "amount": 10, + # "expiry_date": "2022-12-28", + # "block_id": "UiUhFWeLHPrBY4Ad", + # "target_expiry_date": "2023-12-28", + # "description": "Extending credit validity" + # } + # ``` + # + # ## Voiding credits + # + # If you'd like to void a credit block, create a ledger entry of type `void`. For + # this entry, `block_id` is required to identify the block, and `amount` indicates + # how many credits to void, up to the block's initial balance. Pass in a + # `void_reason` of `refund` if the void is due to a refund. + # + # ## Amendment + # + # If you'd like to undo a decrement on a credit block, create a ledger entry of + # type `amendment`. For this entry, `block_id` is required to identify the block + # that was originally decremented from, and `amount` indicates how many credits to + # return to the customer, up to the block's initial balance. sig do params( customer_id: String, @@ -277,153 +277,153 @@ module Orb def create_entry( customer_id, # The number of credits to effect. Note that this is required for increment, - # decrement or void operations. + # decrement or void operations. amount:, entry_type:, # An ISO 8601 format date that identifies the origination credit block to expire expiry_date:, # A future date (specified in YYYY-MM-DD format) used for expiration change, - # denoting when credits transferred (as part of a partial block expiration) should - # expire. + # denoting when credits transferred (as part of a partial block expiration) should + # expire. target_expiry_date:, # The ID of the block to reverse a decrement from. block_id:, # The currency or custom pricing unit to use for this ledger entry. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. currency: nil, # Optional metadata that can be specified when adding ledger results via the API. - # For example, this can be used to note an increment refers to trial credits, or - # for noting corrections as a result of an incident, etc. + # For example, this can be used to note an increment refers to trial credits, or + # for noting corrections as a result of an incident, etc. description: nil, # An ISO 8601 format date that denotes when this credit balance should become - # available for use. + # available for use. effective_date: nil, # Passing `invoice_settings` automatically generates an invoice for the newly - # added credits. If `invoice_settings` is passed, you must specify - # per_unit_cost_basis, as the calculation of the invoice total is done on that - # basis. + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. invoice_settings: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, # Can only be specified when entry_type=increment. How much, in the customer's - # currency, a customer paid for a single credit in this block + # currency, a customer paid for a single credit in this block per_unit_cost_basis: nil, # Can only be specified when `entry_type=void`. The reason for the void. void_reason: nil, request_options: {} ); end # This endpoint allows you to create a new ledger entry for a specified customer's - # balance. This can be used to increment balance, deduct credits, and change the - # expiry date of existing credits. - # - # ## Effects of adding a ledger entry - # - # 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) - # will return a credit block that represents the changes (i.e. balance changes - # or transfers). - # 2. A ledger entry will be added to the credits ledger for this customer, and - # therefore returned in the - # [View Credits Ledger](fetch-customer-credits-ledger) response as well as - # serialized in the response to this request. In the case of deductions without - # a specified block, multiple ledger entries may be created if the deduction - # spans credit blocks. - # 3. If `invoice_settings` is specified, an invoice will be created that reflects - # the cost of the credits (based on `amount` and `per_unit_cost_basis`). - # - # ## Adding credits - # - # Adding credits is done by creating an entry of type `increment`. This requires - # the caller to specify a number of credits as well as an optional expiry date in - # `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with - # auditing. When adding credits, the caller can also specify a cost basis - # per-credit, to indicate how much in USD a customer paid for a single credit in a - # block. This can later be used for revenue recognition. - # - # The following snippet illustrates a sample request body to increment credits - # which will expire in January of 2022. - # - # ```json - # { - # "entry_type": "increment", - # "amount": 100, - # "expiry_date": "2022-12-28", - # "per_unit_cost_basis": "0.20", - # "description": "Purchased 100 credits" - # } - # ``` - # - # Note that by default, Orb will always first increment any _negative_ balance in - # existing blocks before adding the remaining amount to the desired credit block. - # - # ### Invoicing for credits - # - # By default, Orb manipulates the credit ledger but does not charge for credits. - # However, if you pass `invoice_settings` in the body of this request, Orb will - # also generate a one-off invoice for the customer for the credits pre-purchase. - # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges - # on the invoice are calculated by multiplying the cost basis with the number of - # credit units added. - # - # ## Deducting Credits - # - # Orb allows you to deduct credits from a customer by creating an entry of type - # `decrement`. Orb matches the algorithm for automatic deductions for determining - # which credit blocks to decrement from. In the case that the deduction leads to - # multiple ledger entries, the response from this endpoint will be the final - # deduction. Orb also optionally allows specifying a description to assist with - # auditing. - # - # The following snippet illustrates a sample request body to decrement credits. - # - # ```json - # { - # "entry_type": "decrement", - # "amount": 20, - # "description": "Removing excess credits" - # } - # ``` - # - # ## Changing credits expiry - # - # If you'd like to change when existing credits expire, you should create a ledger - # entry of type `expiration_change`. For this entry, the required parameter - # `expiry_date` identifies the _originating_ block, and the required parameter - # `target_expiry_date` identifies when the transferred credits should now expire. - # A new credit block will be created with expiry date `target_expiry_date`, with - # the same cost basis data as the original credit block, if present. - # - # Note that the balance of the block with the given `expiry_date` must be at least - # equal to the desired transfer amount determined by the `amount` parameter. - # - # The following snippet illustrates a sample request body to extend the expiration - # date of credits by one year: - # - # ```json - # { - # "entry_type": "expiration_change", - # "amount": 10, - # "expiry_date": "2022-12-28", - # "block_id": "UiUhFWeLHPrBY4Ad", - # "target_expiry_date": "2023-12-28", - # "description": "Extending credit validity" - # } - # ``` - # - # ## Voiding credits - # - # If you'd like to void a credit block, create a ledger entry of type `void`. For - # this entry, `block_id` is required to identify the block, and `amount` indicates - # how many credits to void, up to the block's initial balance. Pass in a - # `void_reason` of `refund` if the void is due to a refund. - # - # ## Amendment - # - # If you'd like to undo a decrement on a credit block, create a ledger entry of - # type `amendment`. For this entry, `block_id` is required to identify the block - # that was originally decremented from, and `amount` indicates how many credits to - # return to the customer, up to the block's initial balance. + # balance. This can be used to increment balance, deduct credits, and change the + # expiry date of existing credits. + # + # ## Effects of adding a ledger entry + # + # 1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) + # will return a credit block that represents the changes (i.e. balance changes + # or transfers). + # 2. A ledger entry will be added to the credits ledger for this customer, and + # therefore returned in the + # [View Credits Ledger](fetch-customer-credits-ledger) response as well as + # serialized in the response to this request. In the case of deductions without + # a specified block, multiple ledger entries may be created if the deduction + # spans credit blocks. + # 3. If `invoice_settings` is specified, an invoice will be created that reflects + # the cost of the credits (based on `amount` and `per_unit_cost_basis`). + # + # ## Adding credits + # + # Adding credits is done by creating an entry of type `increment`. This requires + # the caller to specify a number of credits as well as an optional expiry date in + # `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with + # auditing. When adding credits, the caller can also specify a cost basis + # per-credit, to indicate how much in USD a customer paid for a single credit in a + # block. This can later be used for revenue recognition. + # + # The following snippet illustrates a sample request body to increment credits + # which will expire in January of 2022. + # + # ```json + # { + # "entry_type": "increment", + # "amount": 100, + # "expiry_date": "2022-12-28", + # "per_unit_cost_basis": "0.20", + # "description": "Purchased 100 credits" + # } + # ``` + # + # Note that by default, Orb will always first increment any _negative_ balance in + # existing blocks before adding the remaining amount to the desired credit block. + # + # ### Invoicing for credits + # + # By default, Orb manipulates the credit ledger but does not charge for credits. + # However, if you pass `invoice_settings` in the body of this request, Orb will + # also generate a one-off invoice for the customer for the credits pre-purchase. + # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges + # on the invoice are calculated by multiplying the cost basis with the number of + # credit units added. + # + # ## Deducting Credits + # + # Orb allows you to deduct credits from a customer by creating an entry of type + # `decrement`. Orb matches the algorithm for automatic deductions for determining + # which credit blocks to decrement from. In the case that the deduction leads to + # multiple ledger entries, the response from this endpoint will be the final + # deduction. Orb also optionally allows specifying a description to assist with + # auditing. + # + # The following snippet illustrates a sample request body to decrement credits. + # + # ```json + # { + # "entry_type": "decrement", + # "amount": 20, + # "description": "Removing excess credits" + # } + # ``` + # + # ## Changing credits expiry + # + # If you'd like to change when existing credits expire, you should create a ledger + # entry of type `expiration_change`. For this entry, the required parameter + # `expiry_date` identifies the _originating_ block, and the required parameter + # `target_expiry_date` identifies when the transferred credits should now expire. + # A new credit block will be created with expiry date `target_expiry_date`, with + # the same cost basis data as the original credit block, if present. + # + # Note that the balance of the block with the given `expiry_date` must be at least + # equal to the desired transfer amount determined by the `amount` parameter. + # + # The following snippet illustrates a sample request body to extend the expiration + # date of credits by one year: + # + # ```json + # { + # "entry_type": "expiration_change", + # "amount": 10, + # "expiry_date": "2022-12-28", + # "block_id": "UiUhFWeLHPrBY4Ad", + # "target_expiry_date": "2023-12-28", + # "description": "Extending credit validity" + # } + # ``` + # + # ## Voiding credits + # + # If you'd like to void a credit block, create a ledger entry of type `void`. For + # this entry, `block_id` is required to identify the block, and `amount` indicates + # how many credits to void, up to the block's initial balance. Pass in a + # `void_reason` of `refund` if the void is due to a refund. + # + # ## Amendment + # + # If you'd like to undo a decrement on a credit block, create a ledger entry of + # type `amendment`. For this entry, `block_id` is required to identify the block + # that was originally decremented from, and `amount` indicates how many credits to + # return to the customer, up to the block's initial balance. sig do params( external_customer_id: String, @@ -461,124 +461,124 @@ module Orb def create_entry_by_external_id( external_customer_id, # The number of credits to effect. Note that this is required for increment, - # decrement or void operations. + # decrement or void operations. amount:, entry_type:, # An ISO 8601 format date that identifies the origination credit block to expire expiry_date:, # A future date (specified in YYYY-MM-DD format) used for expiration change, - # denoting when credits transferred (as part of a partial block expiration) should - # expire. + # denoting when credits transferred (as part of a partial block expiration) should + # expire. target_expiry_date:, # The ID of the block to reverse a decrement from. block_id:, # The currency or custom pricing unit to use for this ledger entry. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. currency: nil, # Optional metadata that can be specified when adding ledger results via the API. - # For example, this can be used to note an increment refers to trial credits, or - # for noting corrections as a result of an incident, etc. + # For example, this can be used to note an increment refers to trial credits, or + # for noting corrections as a result of an incident, etc. description: nil, # An ISO 8601 format date that denotes when this credit balance should become - # available for use. + # available for use. effective_date: nil, # Passing `invoice_settings` automatically generates an invoice for the newly - # added credits. If `invoice_settings` is passed, you must specify - # per_unit_cost_basis, as the calculation of the invoice total is done on that - # basis. + # added credits. If `invoice_settings` is passed, you must specify + # per_unit_cost_basis, as the calculation of the invoice total is done on that + # basis. invoice_settings: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, # Can only be specified when entry_type=increment. How much, in the customer's - # currency, a customer paid for a single credit in this block + # currency, a customer paid for a single credit in this block per_unit_cost_basis: nil, # Can only be specified when `entry_type=void`. The reason for the void. void_reason: nil, request_options: {} ); end # The credits ledger provides _auditing_ functionality over Orb's credits system - # with a list of actions that have taken place to modify a customer's credit - # balance. This [paginated endpoint](/api-reference/pagination) lists these - # entries, starting from the most recent ledger entry. + # with a list of actions that have taken place to modify a customer's credit + # balance. This [paginated endpoint](/api-reference/pagination) lists these + # entries, starting from the most recent ledger entry. # - # More details on using Orb's real-time credit feature are - # [here](/product-catalog/prepurchase). + # More details on using Orb's real-time credit feature are + # [here](/product-catalog/prepurchase). # - # There are four major types of modifications to credit balance, detailed below. + # There are four major types of modifications to credit balance, detailed below. # - # ## Increment + # ## Increment # - # Credits (which optionally expire on a future date) can be added via the API - # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action - # will always contain the total eligible starting and ending balance for the - # customer at the time the entry was added to the ledger. + # Credits (which optionally expire on a future date) can be added via the API + # ([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action + # will always contain the total eligible starting and ending balance for the + # customer at the time the entry was added to the ledger. # - # ## Decrement + # ## Decrement # - # Deductions can occur as a result of an API call to create a ledger entry (see - # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of - # incurring usage. Both ledger entries present the `decrement` entry type. + # Deductions can occur as a result of an API call to create a ledger entry (see + # [Add Ledger Entry](create-ledger-entry)), or automatically as a result of + # incurring usage. Both ledger entries present the `decrement` entry type. # - # As usage for a customer is reported into Orb, credits may be deducted according - # to the customer's plan configuration. An automated deduction of this type will - # result in a ledger entry, also with a starting and ending balance. In order to - # provide better tracing capabilities for automatic deductions, Orb always - # associates each automatic deduction with the `event_id` at the time of - # ingestion, used to pinpoint _why_ credit deduction took place and to ensure that - # credits are never deducted without an associated usage event. + # As usage for a customer is reported into Orb, credits may be deducted according + # to the customer's plan configuration. An automated deduction of this type will + # result in a ledger entry, also with a starting and ending balance. In order to + # provide better tracing capabilities for automatic deductions, Orb always + # associates each automatic deduction with the `event_id` at the time of + # ingestion, used to pinpoint _why_ credit deduction took place and to ensure that + # credits are never deducted without an associated usage event. # - # By default, Orb uses an algorithm that automatically deducts from the _soonest - # expiring credit block_ first in order to ensure that all credits are utilized - # appropriately. As an example, if trial credits with an expiration date of 2 - # weeks from now are present for a customer, they will be used before any - # deductions take place from a non-expiring credit block. + # By default, Orb uses an algorithm that automatically deducts from the _soonest + # expiring credit block_ first in order to ensure that all credits are utilized + # appropriately. As an example, if trial credits with an expiration date of 2 + # weeks from now are present for a customer, they will be used before any + # deductions take place from a non-expiring credit block. # - # If there are multiple blocks with the same expiration date, Orb will deduct from - # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost - # basis before paid credits with a $5.00 cost basis). + # If there are multiple blocks with the same expiration date, Orb will deduct from + # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost + # basis before paid credits with a $5.00 cost basis). # - # It's also possible for a single usage event's deduction to _span_ credit blocks. - # In this case, Orb will deduct from the next block, ending at the credit block - # which consists of unexpiring credits. Each of these deductions will lead to a - # _separate_ ledger entry, one per credit block that is deducted from. By default, - # the customer's total credit balance in Orb can be negative as a result of a - # decrement. + # It's also possible for a single usage event's deduction to _span_ credit blocks. + # In this case, Orb will deduct from the next block, ending at the credit block + # which consists of unexpiring credits. Each of these deductions will lead to a + # _separate_ ledger entry, one per credit block that is deducted from. By default, + # the customer's total credit balance in Orb can be negative as a result of a + # decrement. # - # ## Expiration change + # ## Expiration change # - # The expiry of credits can be changed as a result of the API (See - # [Add Ledger Entry](create-ledger-entry)). This will create a ledger entry that - # specifies the balance as well as the initial and target expiry dates. + # The expiry of credits can be changed as a result of the API (See + # [Add Ledger Entry](create-ledger-entry)). This will create a ledger entry that + # specifies the balance as well as the initial and target expiry dates. # - # Note that for this entry type, `starting_balance` will equal `ending_balance`, - # and the `amount` represents the balance transferred. The credit block linked to - # the ledger entry is the source credit block from which there was an expiration - # change + # Note that for this entry type, `starting_balance` will equal `ending_balance`, + # and the `amount` represents the balance transferred. The credit block linked to + # the ledger entry is the source credit block from which there was an expiration + # change # - # ## Credits expiry + # ## Credits expiry # - # When a set of credits expire on pre-set expiration date, the customer's balance - # automatically reflects this change and adds an entry to the ledger indicating - # this event. Note that credit expiry should always happen close to a date - # boundary in the customer's timezone. + # When a set of credits expire on pre-set expiration date, the customer's balance + # automatically reflects this change and adds an entry to the ledger indicating + # this event. Note that credit expiry should always happen close to a date + # boundary in the customer's timezone. # - # ## Void initiated + # ## Void initiated # - # Credit blocks can be voided via the API. The `amount` on this entry corresponds - # to the number of credits that were remaining in the block at time of void. - # `void_reason` will be populated if the void is created with a reason. + # Credit blocks can be voided via the API. The `amount` on this entry corresponds + # to the number of credits that were remaining in the block at time of void. + # `void_reason` will be populated if the void is created with a reason. # - # ## Void + # ## Void # - # When a set of credits is voided, the customer's balance automatically reflects - # this change and adds an entry to the ledger indicating this event. + # When a set of credits is voided, the customer's balance automatically reflects + # this change and adds an entry to the ledger indicating this event. # - # ## Amendment + # ## Amendment # - # When credits are added to a customer's balance as a result of a correction, this - # entry will be added to the ledger to indicate the adjustment of credits. + # When credits are added to a customer's balance as a result of a correction, this + # entry will be added to the ledger to indicate the adjustment of credits. sig do params( external_customer_id: String, @@ -617,7 +617,7 @@ module Orb # The ledger currency or custom pricing unit to use. currency: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, entry_status: nil, entry_type: nil, diff --git a/rbi/lib/orb/resources/customers/credits/top_ups.rbi b/rbi/lib/orb/resources/customers/credits/top_ups.rbi index 88907fdd..63f15465 100644 --- a/rbi/lib/orb/resources/customers/credits/top_ups.rbi +++ b/rbi/lib/orb/resources/customers/credits/top_ups.rbi @@ -6,12 +6,12 @@ module Orb class Credits class TopUps # This endpoint allows you to create a new top-up for a specified customer's - # balance. While this top-up is active, the customer's balance will added in - # increments of the specified amount whenever the balance reaches the specified - # threshold. + # balance. While this top-up is active, the customer's balance will added in + # increments of the specified amount whenever the balance reaches the specified + # threshold. # - # If a top-up already exists for this customer in the same currency, the existing - # top-up will be replaced. + # If a top-up already exists for this customer in the same currency, the existing + # top-up will be replaced. sig do params( customer_id: String, @@ -32,20 +32,20 @@ module Orb # The amount to increment when the threshold is reached. amount:, # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. currency:, # Settings for invoices generated by triggered top-ups. invoice_settings:, # How much, in the customer's currency, to charge for each unit. per_unit_cost_basis:, # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. threshold:, # The date from which the top-up is active. If unspecified, the top-up is active - # immediately. + # immediately. active_from: nil, # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. expires_after: nil, # The unit of expires_after. expires_after_unit: nil, @@ -64,14 +64,14 @@ module Orb def list( customer_id, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} ); end # This deactivates the top-up and voids any invoices associated with pending - # credit blocks purchased through the top-up. + # credit blocks purchased through the top-up. sig do params( top_up_id: String, @@ -83,12 +83,12 @@ module Orb def delete(top_up_id, customer_id:, request_options: {}); end # This endpoint allows you to create a new top-up for a specified customer's - # balance. While this top-up is active, the customer's balance will added in - # increments of the specified amount whenever the balance reaches the specified - # threshold. + # balance. While this top-up is active, the customer's balance will added in + # increments of the specified amount whenever the balance reaches the specified + # threshold. # - # If a top-up already exists for this customer in the same currency, the existing - # top-up will be replaced. + # If a top-up already exists for this customer in the same currency, the existing + # top-up will be replaced. sig do params( external_customer_id: String, @@ -112,27 +112,27 @@ module Orb # The amount to increment when the threshold is reached. amount:, # The currency or custom pricing unit to use for this top-up. If this is a - # real-world currency, it must match the customer's invoicing currency. + # real-world currency, it must match the customer's invoicing currency. currency:, # Settings for invoices generated by triggered top-ups. invoice_settings:, # How much, in the customer's currency, to charge for each unit. per_unit_cost_basis:, # The threshold at which to trigger the top-up. If the balance is at or below this - # threshold, the top-up will be triggered. + # threshold, the top-up will be triggered. threshold:, # The date from which the top-up is active. If unspecified, the top-up is active - # immediately. + # immediately. active_from: nil, # The number of days or months after which the top-up expires. If unspecified, it - # does not expire. + # does not expire. expires_after: nil, # The unit of expires_after. expires_after_unit: nil, request_options: {} ); end # This deactivates the top-up and voids any invoices associated with pending - # credit blocks purchased through the top-up. + # credit blocks purchased through the top-up. sig do params( top_up_id: String, @@ -156,7 +156,7 @@ module Orb def list_by_external_id( external_customer_id, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, diff --git a/rbi/lib/orb/resources/dimensional_price_groups.rbi b/rbi/lib/orb/resources/dimensional_price_groups.rbi index e64a1365..7b06b376 100644 --- a/rbi/lib/orb/resources/dimensional_price_groups.rbi +++ b/rbi/lib/orb/resources/dimensional_price_groups.rbi @@ -7,13 +7,13 @@ module Orb attr_reader :external_dimensional_price_group_id # A dimensional price group is used to partition the result of a billable metric - # by a set of dimensions. Prices in a price group must specify the parition used - # to derive their usage. + # by a set of dimensions. Prices in a price group must specify the parition used + # to derive their usage. # - # For example, suppose we have a billable metric that measures the number of - # widgets used and we want to charge differently depending on the color of the - # widget. We can create a price group with a dimension "color" and two prices: one - # that charges $10 per red widget and one that charges $20 per blue widget. + # For example, suppose we have a billable metric that measures the number of + # widgets used and we want to charge differently depending on the color of the + # widget. We can create a price group with a dimension "color" and two prices: one + # that charges $10 per red widget and one that charges $20 per blue widget. sig do params( billable_metric_id: String, @@ -32,8 +32,8 @@ module Orb name:, external_dimensional_price_group_id: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end @@ -58,7 +58,7 @@ module Orb end def list( # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, diff --git a/rbi/lib/orb/resources/events.rbi b/rbi/lib/orb/resources/events.rbi index bbf270c1..9b68c9cc 100644 --- a/rbi/lib/orb/resources/events.rbi +++ b/rbi/lib/orb/resources/events.rbi @@ -10,50 +10,50 @@ module Orb attr_reader :volume # This endpoint is used to amend a single usage event with a given `event_id`. - # `event_id` refers to the `idempotency_key` passed in during ingestion. The event - # will maintain its existing `event_id` after the amendment. - # - # This endpoint will mark the existing event as ignored, and Orb will only use the - # new event passed in the body of this request as the source of truth for that - # `event_id`. Note that a single event can be amended any number of times, so the - # same event can be overwritten in subsequent calls to this endpoint. Only a - # single event with a given `event_id` will be considered the source of truth at - # any given time. - # - # This is a powerful and audit-safe mechanism to retroactively update a single - # event in cases where you need to: - # - # - update an event with new metadata as you iterate on your pricing model - # - update an event based on the result of an external API call (e.g. call to a - # payment gateway succeeded or failed) - # - # This amendment API is always audit-safe. The process will still retain the - # original event, though it will be ignored for billing calculations. For auditing - # and data fidelity purposes, Orb never overwrites or permanently deletes ingested - # usage data. - # - # ## Request validation - # - # - The `timestamp` of the new event must match the `timestamp` of the existing - # event already ingested. As with ingestion, all timestamps must be sent in - # ISO8601 format with UTC timezone offset. - # - The `customer_id` or `external_customer_id` of the new event must match the - # `customer_id` or `external_customer_id` of the existing event already - # ingested. Exactly one of `customer_id` and `external_customer_id` should be - # specified, and similar to ingestion, the ID must identify a Customer resource - # within Orb. Unlike ingestion, for event amendment, we strictly enforce that - # the Customer must be in the Orb system, even during the initial integration - # period. We do not allow updating the `Customer` an event is associated with. - # - Orb does not accept an `idempotency_key` with the event in this endpoint, - # since this request is by design idempotent. On retryable errors, you should - # retry the request and assume the amendment operation has not succeeded until - # receipt of a 2xx. - # - The event's `timestamp` must fall within the customer's current subscription's - # billing period, or within the grace period of the customer's current - # subscription's previous billing period. - # - By default, no more than 100 events can be amended for a single customer in a - # 100 day period. For higher volume updates, consider using the - # [event backfill](create-backfill) endpoint. + # `event_id` refers to the `idempotency_key` passed in during ingestion. The event + # will maintain its existing `event_id` after the amendment. + # + # This endpoint will mark the existing event as ignored, and Orb will only use the + # new event passed in the body of this request as the source of truth for that + # `event_id`. Note that a single event can be amended any number of times, so the + # same event can be overwritten in subsequent calls to this endpoint. Only a + # single event with a given `event_id` will be considered the source of truth at + # any given time. + # + # This is a powerful and audit-safe mechanism to retroactively update a single + # event in cases where you need to: + # + # - update an event with new metadata as you iterate on your pricing model + # - update an event based on the result of an external API call (e.g. call to a + # payment gateway succeeded or failed) + # + # This amendment API is always audit-safe. The process will still retain the + # original event, though it will be ignored for billing calculations. For auditing + # and data fidelity purposes, Orb never overwrites or permanently deletes ingested + # usage data. + # + # ## Request validation + # + # - The `timestamp` of the new event must match the `timestamp` of the existing + # event already ingested. As with ingestion, all timestamps must be sent in + # ISO8601 format with UTC timezone offset. + # - The `customer_id` or `external_customer_id` of the new event must match the + # `customer_id` or `external_customer_id` of the existing event already + # ingested. Exactly one of `customer_id` and `external_customer_id` should be + # specified, and similar to ingestion, the ID must identify a Customer resource + # within Orb. Unlike ingestion, for event amendment, we strictly enforce that + # the Customer must be in the Orb system, even during the initial integration + # period. We do not allow updating the `Customer` an event is associated with. + # - Orb does not accept an `idempotency_key` with the event in this endpoint, + # since this request is by design idempotent. On retryable errors, you should + # retry the request and assume the amendment operation has not succeeded until + # receipt of a 2xx. + # - The event's `timestamp` must fall within the customer's current subscription's + # billing period, or within the grace period of the customer's current + # subscription's previous billing period. + # - By default, no more than 100 events can be amended for a single customer in a + # 100 day period. For higher volume updates, consider using the + # [event backfill](create-backfill) endpoint. sig do params( event_id: String, @@ -71,59 +71,59 @@ module Orb # A name to meaningfully identify the action or event type. event_name:, # A dictionary of custom properties. Values in this dictionary must be numeric, - # boolean, or strings. Nested dictionaries are disallowed. + # boolean, or strings. Nested dictionaries are disallowed. properties:, # An ISO 8601 format date with no timezone offset (i.e. UTC). This should - # represent the time that usage was recorded, and is particularly important to - # attribute usage to a given billing period. + # represent the time that usage was recorded, and is particularly important to + # attribute usage to a given billing period. timestamp:, # The Orb Customer identifier customer_id: nil, # An alias for the Orb customer, whose mapping is specified when creating the - # customer + # customer external_customer_id: nil, request_options: {} ); end # This endpoint is used to deprecate a single usage event with a given `event_id`. - # `event_id` refers to the `idempotency_key` passed in during ingestion. - # - # This endpoint will mark the existing event as ignored. Note that if you attempt - # to re-ingest an event with the same `event_id` as a deprecated event, Orb will - # return an error. - # - # This is a powerful and audit-safe mechanism to retroactively deprecate a single - # event in cases where you need to: - # - # - no longer bill for an event that was improperly reported - # - no longer bill for an event based on the result of an external API call (e.g. - # call to a payment gateway failed and the user should not be billed) - # - # If you want to only change specific properties of an event, but keep the event - # as part of the billing calculation, use the [Amend event](amend-event) endpoint - # instead. - # - # This API is always audit-safe. The process will still retain the deprecated - # event, though it will be ignored for billing calculations. For auditing and data - # fidelity purposes, Orb never overwrites or permanently deletes ingested usage - # data. - # - # ## Request validation - # - # - Orb does not accept an `idempotency_key` with the event in this endpoint, - # since this request is by design idempotent. On retryable errors, you should - # retry the request and assume the deprecation operation has not succeeded until - # receipt of a 2xx. - # - The event's `timestamp` must fall within the customer's current subscription's - # billing period, or within the grace period of the customer's current - # subscription's previous billing period. Orb does not allow deprecating events - # for billing periods that have already invoiced customers. - # - The `customer_id` or the `external_customer_id` of the original event - # ingestion request must identify a Customer resource within Orb, even if this - # event was ingested during the initial integration period. We do not allow - # deprecating events for customers not in the Orb system. - # - By default, no more than 100 events can be deprecated for a single customer in - # a 100 day period. For higher volume updates, consider using the - # [event backfill](create-backfill) endpoint. + # `event_id` refers to the `idempotency_key` passed in during ingestion. + # + # This endpoint will mark the existing event as ignored. Note that if you attempt + # to re-ingest an event with the same `event_id` as a deprecated event, Orb will + # return an error. + # + # This is a powerful and audit-safe mechanism to retroactively deprecate a single + # event in cases where you need to: + # + # - no longer bill for an event that was improperly reported + # - no longer bill for an event based on the result of an external API call (e.g. + # call to a payment gateway failed and the user should not be billed) + # + # If you want to only change specific properties of an event, but keep the event + # as part of the billing calculation, use the [Amend event](amend-event) endpoint + # instead. + # + # This API is always audit-safe. The process will still retain the deprecated + # event, though it will be ignored for billing calculations. For auditing and data + # fidelity purposes, Orb never overwrites or permanently deletes ingested usage + # data. + # + # ## Request validation + # + # - Orb does not accept an `idempotency_key` with the event in this endpoint, + # since this request is by design idempotent. On retryable errors, you should + # retry the request and assume the deprecation operation has not succeeded until + # receipt of a 2xx. + # - The event's `timestamp` must fall within the customer's current subscription's + # billing period, or within the grace period of the customer's current + # subscription's previous billing period. Orb does not allow deprecating events + # for billing periods that have already invoiced customers. + # - The `customer_id` or the `external_customer_id` of the original event + # ingestion request must identify a Customer resource within Orb, even if this + # event was ingested during the initial integration period. We do not allow + # deprecating events for customers not in the Orb system. + # - By default, no more than 100 events can be deprecated for a single customer in + # a 100 day period. For higher volume updates, consider using the + # [event backfill](create-backfill) endpoint. sig do params( event_id: String, @@ -135,208 +135,208 @@ module Orb # Orb's event ingestion model and API is designed around two core principles: # - # 1. **Data fidelity**: The accuracy of your billing model depends on a robust - # foundation of events. Orb's API protocol encourages usage patterns that - # ensure that your data is consistently complete and correct. - # 2. **Fast integration**: Sending events into Orb requires no tedious setup steps - # or explicit field schema for your event shape, making it instant to start - # streaming in usage in real-time. - # - # ## Event shape - # - # Events are the starting point for all usage calculations in the system, and are - # simple at their core: - # - # ```ts - # { - # // customer_id and external_customer_id are used to - # // attribute usage to a given Customer. Exactly one of these - # // should be specified in a given ingestion event. - # - # // `customer_id` is the Orb generated identifier for the Customer, - # // which is returned from the Create customer API call. - # customer_id: string, - # - # // external_customer_id is an alternate identifier which is associated - # // with a Customer at creation time. This is treated as an alias for - # // customer_id, and is usually set to an identifier native to your system. - # external_customer_id: string, - # - # // A string name identifying the event, usually a usage - # // action. By convention, this should not contain any whitespace. - # event_name: string, - # - # // An ISO 8601 format date with no timezone offset. - # // This should represent the time that usage occurred - # // and is important to attribute usage to a given - # // billing period. See the notes below on determining the timestamp. - # // e.g. 2020-12-09T16:09:53Z - # timestamp: string, - # - # // A unique value, generated by the client, that is - # // used to de-duplicate events. - # // Exactly one event with a given - # // idempotency key will be ingested, which allows for - # // safe request retries. - # idempotency_key: string - # - # // Optional custom metadata to attach to the event. - # // This might include a numeric value used for aggregation, - # // or a string/boolean value used for filtering. - # // The schema of this dictionary need not be pre-declared, and - # // properties can be added at any time. - # properties: { - # [key: string]?: string | number | boolean, - # }, - # } - # ``` - # - # ## Required fields - # - # Because events streamed to Orb are meant to be as flexible as possible, there - # are only a few required fields in every event. - # - # - We recommend that `idempotency_key` are unique strings that you generated with - # V4 UUIDs, but only require that they uniquely identify an event (i.e. don’t - # collide). - # - The `timestamp` field in the event body will be used to determine which - # billable period a given event falls into. For example, with a monthly billing - # cycle starting from the first of December, Orb will calculate metrics based on - # events that fall into the range - # `12-01 00:00:00 <= timestamp < 01-01 00:00:00`. - # - # ## Logging metadata - # - # Orb allows tagging events with metadata using a flexible properties dictionary. - # Since Orb does not enforce a rigid schema for this field-set, key-value pairs - # can be added dynamically as your events evolve. - # - # This dictionary can be helpful for a wide variety of use cases: - # - # - Numeric properties on events like `compute_time_ms` can later be inputs to our - # flexible query engine to determine usage. - # - Logging a region or cluster with each event can help you provide customers - # more granular visibility into their usage. - # - If you are using matrix pricing and matching a matrix price key with a - # property, you should ensure the value for that property is sent as a string. - # - # We encourage logging this metadata with an eye towards future use cases to - # ensure full coverage for historical data. The datatype of the value in the - # properties dictionary is important for metric creation from an event source. - # Values that you wish to numerically aggregate should be of numeric type in the - # event. - # - # ## Determining event timestamp - # - # For cases where usage is being reported in real time as it is occurring, - # timestamp should correspond to the time that usage occurred. - # - # In cases where usage is reported in aggregate for a historical timeframe at a - # regular interval, we recommend setting the event `timestamp` to the midpoint of - # the interval. As an example, if you have an hourly reporter that sends data once - # an hour for the previous hour of usage, setting the `timestamp` to the half-hour - # mark will ensure that the usage is counted within the correct period. - # - # Note that other time-related fields (e.g. time elapsed) can be added to the - # properties dictionary as necessary. - # - # In cases where usage is reported in aggregate for a historical timeframe, the - # timestamp must be within the grace period set for your account. Events with - # `timestamp < current_time - grace_period` will not be accepted as a valid event, - # and will throw validation errors. Enforcing the grace period enables Orb to - # accurately map usage to the correct billing cycle and ensure that all usage is - # billed for in the corresponding billing period. - # - # In general, Orb does not expect events with future dated timestamps. In cases - # where the timestamp is at least 24 hours ahead of the current time, the event - # will not be accepted as a valid event, and will throw validation errors. - # - # ## Event validation - # - # Orb’s validation ensures that you recognize errors in your events as quickly as - # possible, and the API provides informative error messages to help you fix - # problems quickly. - # - # We validate the following: - # - # - Exactly one of `customer_id` and `external_customer_id` should be specified. - # - If the `customer_id` is specified, the customer in Orb must exist. - # - If the `external_customer_id` is specified, the customer in Orb does not need - # to exist. Events will be attributed to any future customers with the - # `external_customer_id` on subscription creation. - # - `timestamp` must conform to ISO 8601 and represent a timestamp at most 1 hour - # in the future. This timestamp should be sent in UTC timezone (no timezone - # offset). - # - # ## Idempotency and retry semantics - # - # Orb's idempotency guarantees allow you to implement safe retry logic in the - # event of network or machine failures, ensuring data fidelity. Each event in the - # request payload is associated with an idempotency key, and Orb guarantees that a - # single idempotency key will be successfully ingested at most once. Note that - # when Orb encounters events with duplicate idempotency keys and differing event - # bodies in a batch of events, the entire batch will be rejected. - # - # - Successful responses return a 200 HTTP status code. The response contains - # information about previously processed events. - # - Requests that return a `4xx` HTTP status code indicate a payload error and - # contain at least one event with a validation failure. An event with a - # validation failure can be re-sent to the ingestion endpoint (after the payload - # is fixed) with the original idempotency key since that key is not marked as - # processed. - # - Requests that return a `5xx` HTTP status code indicate a server-side failure. - # These requests should be retried in their entirety. - # - # ## API usage and limits - # - # The ingestion API is designed made for real-time streaming ingestion and - # architected for high throughput. Even if events are later deemed unnecessary or - # filtered out, we encourage you to log them to Orb if they may be relevant to - # billing calculations in the future. - # - # To take advantage of the real-time features of the Orb platform and avoid any - # chance of dropped events by producers, we recommend reporting events to Orb - # frequently. Optionally, events can also be briefly aggregated at the source, as - # this API accepts an array of event bodies. - # - # Orb does not currently enforce a hard rate-limit for API usage or a maximum - # request payload size, but please give us a heads up if you’re changing either of - # these factors by an order of magnitude from initial setup. - # - # ## Testing in debug mode - # - # The ingestion API supports a debug mode, which returns additional verbose output - # to indicate which event idempotency keys were newly ingested or duplicates from - # previous requests. To enable this mode, mark `debug=true` as a query parameter. - # - # If `debug=true` is not specified, the response will only contain - # `validation_failed`. Orb will still honor the idempotency guarantees set - # [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all - # cases. - # - # We strongly recommend that you only use debug mode as part of testing your - # initial Orb integration. Once you're ready to switch to production, disable - # debug mode to take advantage of improved performance and maximal throughput. - # - # #### Example: ingestion response with `debug=true` - # - # ```json - # { - # "debug": { - # "duplicate": [], - # "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"] - # }, - # "validation_failed": [] - # } - # ``` - # - # #### Example: ingestion response with `debug=false` - # - # ```json - # { - # "validation_failed": [] - # } - # ``` + # 1. **Data fidelity**: The accuracy of your billing model depends on a robust + # foundation of events. Orb's API protocol encourages usage patterns that + # ensure that your data is consistently complete and correct. + # 2. **Fast integration**: Sending events into Orb requires no tedious setup steps + # or explicit field schema for your event shape, making it instant to start + # streaming in usage in real-time. + # + # ## Event shape + # + # Events are the starting point for all usage calculations in the system, and are + # simple at their core: + # + # ```ts + # { + # // customer_id and external_customer_id are used to + # // attribute usage to a given Customer. Exactly one of these + # // should be specified in a given ingestion event. + # + # // `customer_id` is the Orb generated identifier for the Customer, + # // which is returned from the Create customer API call. + # customer_id: string, + # + # // external_customer_id is an alternate identifier which is associated + # // with a Customer at creation time. This is treated as an alias for + # // customer_id, and is usually set to an identifier native to your system. + # external_customer_id: string, + # + # // A string name identifying the event, usually a usage + # // action. By convention, this should not contain any whitespace. + # event_name: string, + # + # // An ISO 8601 format date with no timezone offset. + # // This should represent the time that usage occurred + # // and is important to attribute usage to a given + # // billing period. See the notes below on determining the timestamp. + # // e.g. 2020-12-09T16:09:53Z + # timestamp: string, + # + # // A unique value, generated by the client, that is + # // used to de-duplicate events. + # // Exactly one event with a given + # // idempotency key will be ingested, which allows for + # // safe request retries. + # idempotency_key: string + # + # // Optional custom metadata to attach to the event. + # // This might include a numeric value used for aggregation, + # // or a string/boolean value used for filtering. + # // The schema of this dictionary need not be pre-declared, and + # // properties can be added at any time. + # properties: { + # [key: string]?: string | number | boolean, + # }, + # } + # ``` + # + # ## Required fields + # + # Because events streamed to Orb are meant to be as flexible as possible, there + # are only a few required fields in every event. + # + # - We recommend that `idempotency_key` are unique strings that you generated with + # V4 UUIDs, but only require that they uniquely identify an event (i.e. don’t + # collide). + # - The `timestamp` field in the event body will be used to determine which + # billable period a given event falls into. For example, with a monthly billing + # cycle starting from the first of December, Orb will calculate metrics based on + # events that fall into the range + # `12-01 00:00:00 <= timestamp < 01-01 00:00:00`. + # + # ## Logging metadata + # + # Orb allows tagging events with metadata using a flexible properties dictionary. + # Since Orb does not enforce a rigid schema for this field-set, key-value pairs + # can be added dynamically as your events evolve. + # + # This dictionary can be helpful for a wide variety of use cases: + # + # - Numeric properties on events like `compute_time_ms` can later be inputs to our + # flexible query engine to determine usage. + # - Logging a region or cluster with each event can help you provide customers + # more granular visibility into their usage. + # - If you are using matrix pricing and matching a matrix price key with a + # property, you should ensure the value for that property is sent as a string. + # + # We encourage logging this metadata with an eye towards future use cases to + # ensure full coverage for historical data. The datatype of the value in the + # properties dictionary is important for metric creation from an event source. + # Values that you wish to numerically aggregate should be of numeric type in the + # event. + # + # ## Determining event timestamp + # + # For cases where usage is being reported in real time as it is occurring, + # timestamp should correspond to the time that usage occurred. + # + # In cases where usage is reported in aggregate for a historical timeframe at a + # regular interval, we recommend setting the event `timestamp` to the midpoint of + # the interval. As an example, if you have an hourly reporter that sends data once + # an hour for the previous hour of usage, setting the `timestamp` to the half-hour + # mark will ensure that the usage is counted within the correct period. + # + # Note that other time-related fields (e.g. time elapsed) can be added to the + # properties dictionary as necessary. + # + # In cases where usage is reported in aggregate for a historical timeframe, the + # timestamp must be within the grace period set for your account. Events with + # `timestamp < current_time - grace_period` will not be accepted as a valid event, + # and will throw validation errors. Enforcing the grace period enables Orb to + # accurately map usage to the correct billing cycle and ensure that all usage is + # billed for in the corresponding billing period. + # + # In general, Orb does not expect events with future dated timestamps. In cases + # where the timestamp is at least 24 hours ahead of the current time, the event + # will not be accepted as a valid event, and will throw validation errors. + # + # ## Event validation + # + # Orb’s validation ensures that you recognize errors in your events as quickly as + # possible, and the API provides informative error messages to help you fix + # problems quickly. + # + # We validate the following: + # + # - Exactly one of `customer_id` and `external_customer_id` should be specified. + # - If the `customer_id` is specified, the customer in Orb must exist. + # - If the `external_customer_id` is specified, the customer in Orb does not need + # to exist. Events will be attributed to any future customers with the + # `external_customer_id` on subscription creation. + # - `timestamp` must conform to ISO 8601 and represent a timestamp at most 1 hour + # in the future. This timestamp should be sent in UTC timezone (no timezone + # offset). + # + # ## Idempotency and retry semantics + # + # Orb's idempotency guarantees allow you to implement safe retry logic in the + # event of network or machine failures, ensuring data fidelity. Each event in the + # request payload is associated with an idempotency key, and Orb guarantees that a + # single idempotency key will be successfully ingested at most once. Note that + # when Orb encounters events with duplicate idempotency keys and differing event + # bodies in a batch of events, the entire batch will be rejected. + # + # - Successful responses return a 200 HTTP status code. The response contains + # information about previously processed events. + # - Requests that return a `4xx` HTTP status code indicate a payload error and + # contain at least one event with a validation failure. An event with a + # validation failure can be re-sent to the ingestion endpoint (after the payload + # is fixed) with the original idempotency key since that key is not marked as + # processed. + # - Requests that return a `5xx` HTTP status code indicate a server-side failure. + # These requests should be retried in their entirety. + # + # ## API usage and limits + # + # The ingestion API is designed made for real-time streaming ingestion and + # architected for high throughput. Even if events are later deemed unnecessary or + # filtered out, we encourage you to log them to Orb if they may be relevant to + # billing calculations in the future. + # + # To take advantage of the real-time features of the Orb platform and avoid any + # chance of dropped events by producers, we recommend reporting events to Orb + # frequently. Optionally, events can also be briefly aggregated at the source, as + # this API accepts an array of event bodies. + # + # Orb does not currently enforce a hard rate-limit for API usage or a maximum + # request payload size, but please give us a heads up if you’re changing either of + # these factors by an order of magnitude from initial setup. + # + # ## Testing in debug mode + # + # The ingestion API supports a debug mode, which returns additional verbose output + # to indicate which event idempotency keys were newly ingested or duplicates from + # previous requests. To enable this mode, mark `debug=true` as a query parameter. + # + # If `debug=true` is not specified, the response will only contain + # `validation_failed`. Orb will still honor the idempotency guarantees set + # [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all + # cases. + # + # We strongly recommend that you only use debug mode as part of testing your + # initial Orb integration. Once you're ready to switch to production, disable + # debug mode to take advantage of improved performance and maximal throughput. + # + # #### Example: ingestion response with `debug=true` + # + # ```json + # { + # "debug": { + # "duplicate": [], + # "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"] + # }, + # "validation_failed": [] + # } + # ``` + # + # #### Example: ingestion response with `debug=false` + # + # ```json + # { + # "validation_failed": [] + # } + # ``` sig do params( events: T::Array[T.any(Orb::Models::EventIngestParams::Event, Orb::Internal::AnyHash)], @@ -350,28 +350,28 @@ module Orb # Body param: events:, # Query param: If this ingestion request is part of a backfill, this parameter - # ties the ingested events to the backfill + # ties the ingested events to the backfill backfill_id: nil, # Query param: Flag to enable additional debug information in the endpoint - # response + # response debug: nil, request_options: {} ); end # This endpoint returns a filtered set of events for an account in a - # [paginated list format](/api-reference/pagination). + # [paginated list format](/api-reference/pagination). # - # Note that this is a `POST` endpoint rather than a `GET` endpoint because it - # employs a JSON body for search criteria rather than query parameters, allowing - # for a more flexible search syntax. + # Note that this is a `POST` endpoint rather than a `GET` endpoint because it + # employs a JSON body for search criteria rather than query parameters, allowing + # for a more flexible search syntax. # - # Note that a search criteria _must_ be specified. Currently, Orb supports the - # following criteria: + # Note that a search criteria _must_ be specified. Currently, Orb supports the + # following criteria: # - # - `event_ids`: This is an explicit array of IDs to filter by. Note that an - # event's ID is the `idempotency_key` that was originally used for ingestion. + # - `event_ids`: This is an explicit array of IDs to filter by. Note that an + # event's ID is the `idempotency_key` that was originally used for ingestion. # - # By default, Orb will not throw a `404` if no events matched, Orb will return an - # empty array for `data` instead. + # By default, Orb will not throw a `404` if no events matched, Orb will return an + # empty array for `data` instead. sig do params( event_ids: T::Array[String], @@ -383,15 +383,15 @@ module Orb end def search( # This is an explicit array of IDs to filter by. Note that an event's ID is the - # idempotency_key that was originally used for ingestion, and this only supports - # events that have not been amended. Values in this array will be treated case - # sensitively. + # idempotency_key that was originally used for ingestion, and this only supports + # events that have not been amended. Values in this array will be treated case + # sensitively. event_ids:, # The end of the timeframe, exclusive, in which to search events. If not - # specified, the current time is used. + # specified, the current time is used. timeframe_end: nil, # The start of the timeframe, inclusive, in which to search events. If not - # specified, the one week ago is used. + # specified, the one week ago is used. timeframe_start: nil, request_options: {} ); end diff --git a/rbi/lib/orb/resources/events/backfills.rbi b/rbi/lib/orb/resources/events/backfills.rbi index bc8ac6da..cff76f0b 100644 --- a/rbi/lib/orb/resources/events/backfills.rbi +++ b/rbi/lib/orb/resources/events/backfills.rbi @@ -5,42 +5,42 @@ module Orb class Events class Backfills # Creating the backfill enables adding or replacing past events, even those that - # are older than the ingestion grace period. Performing a backfill in Orb involves - # 3 steps: + # are older than the ingestion grace period. Performing a backfill in Orb involves + # 3 steps: # - # 1. Create the backfill, specifying its parameters. - # 2. [Ingest](ingest) usage events, referencing the backfill (query parameter - # `backfill_id`). - # 3. [Close](close-backfill) the backfill, propagating the update in past usage - # throughout Orb. + # 1. Create the backfill, specifying its parameters. + # 2. [Ingest](ingest) usage events, referencing the backfill (query parameter + # `backfill_id`). + # 3. [Close](close-backfill) the backfill, propagating the update in past usage + # throughout Orb. # - # Changes from a backfill are not reflected until the backfill is closed, so you - # won’t need to worry about your customers seeing partially updated usage data. - # Backfills are also reversible, so you’ll be able to revert a backfill if you’ve - # made a mistake. + # Changes from a backfill are not reflected until the backfill is closed, so you + # won’t need to worry about your customers seeing partially updated usage data. + # Backfills are also reversible, so you’ll be able to revert a backfill if you’ve + # made a mistake. # - # This endpoint will return a backfill object, which contains an `id`. That `id` - # can then be used as the `backfill_id` query parameter to the event ingestion - # endpoint to associate ingested events with this backfill. The effects (e.g. - # updated usage graphs) of this backfill will not take place until the backfill is - # closed. + # This endpoint will return a backfill object, which contains an `id`. That `id` + # can then be used as the `backfill_id` query parameter to the event ingestion + # endpoint to associate ingested events with this backfill. The effects (e.g. + # updated usage graphs) of this backfill will not take place until the backfill is + # closed. # - # If the `replace_existing_events` is `true`, existing events in the backfill's - # timeframe will be replaced with the newly ingested events associated with the - # backfill. If `false`, newly ingested events will be added to the existing - # events. + # If the `replace_existing_events` is `true`, existing events in the backfill's + # timeframe will be replaced with the newly ingested events associated with the + # backfill. If `false`, newly ingested events will be added to the existing + # events. # - # If a `customer_id` or `external_customer_id` is specified, the backfill will - # only affect events for that customer. If neither is specified, the backfill will - # affect all customers. + # If a `customer_id` or `external_customer_id` is specified, the backfill will + # only affect events for that customer. If neither is specified, the backfill will + # affect all customers. # - # When `replace_existing_events` is `true`, this indicates that existing events in - # the timeframe should no longer be counted towards invoiced usage. In this - # scenario, the parameter `filter` can be optionally added which enables filtering - # using - # [computed properties](/extensibility/advanced-metrics#computed-properties). The - # expressiveness of computed properties allows you to deprecate existing events - # based on both a period of time and specific property values. + # When `replace_existing_events` is `true`, this indicates that existing events in + # the timeframe should no longer be counted towards invoiced usage. In this + # scenario, the parameter `filter` can be optionally added which enables filtering + # using + # [computed properties](/extensibility/advanced-metrics#computed-properties). The + # expressiveness of computed properties allows you to deprecate existing events + # based on both a period of time and specific property values. sig do params( timeframe_end: Time, @@ -56,39 +56,39 @@ module Orb end def create( # The (exclusive) end of the usage timeframe affected by this backfill. By - # default, Orb allows backfills up to 10 days in duration at a time. Reach out to - # discuss extending this limit and your use case. + # default, Orb allows backfills up to 10 days in duration at a time. Reach out to + # discuss extending this limit and your use case. timeframe_end:, # The (inclusive) start of the usage timeframe affected by this backfill. By - # default, Orb allows backfills up to 10 days in duration at a time. Reach out to - # discuss extending this limit and your use case. + # default, Orb allows backfills up to 10 days in duration at a time. Reach out to + # discuss extending this limit and your use case. timeframe_start:, # The time at which no more events will be accepted for this backfill. The - # backfill will automatically begin reflecting throughout Orb at the close time. - # If not specified, it will default to 1 day after the creation of the backfill. + # backfill will automatically begin reflecting throughout Orb at the close time. + # If not specified, it will default to 1 day after the creation of the backfill. close_time: nil, # The Orb-generated ID of the customer to which this backfill is scoped. Omitting - # this field will scope the backfill to all customers. + # this field will scope the backfill to all customers. customer_id: nil, # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the set of events to deprecate deprecation_filter: nil, # The external customer ID of the customer to which this backfill is scoped. - # Omitting this field will scope the backfill to all customers. + # Omitting this field will scope the backfill to all customers. external_customer_id: nil, # If true, replaces all existing events in the timeframe with the newly ingested - # events. If false, adds the newly ingested events to the existing events. + # events. If false, adds the newly ingested events to the existing events. replace_existing_events: nil, request_options: {} ); end # This endpoint returns a list of all backfills in a list format. # - # The list of backfills is ordered starting from the most recently created - # backfill. The response also includes - # [`pagination_metadata`](/api-reference/pagination), which lets the caller - # retrieve the next page of results if they exist. More information about - # pagination can be found in the [Pagination-metadata schema](pagination). + # The list of backfills is ordered starting from the most recently created + # backfill. The response also includes + # [`pagination_metadata`](/api-reference/pagination), which lets the caller + # retrieve the next page of results if they exist. More information about + # pagination can be found in the [Pagination-metadata schema](pagination). sig do params( cursor: T.nilable(String), @@ -99,16 +99,16 @@ module Orb end def list( # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} ); end # Closing a backfill makes the updated usage visible in Orb. Upon closing a - # backfill, Orb will asynchronously reflect the updated usage in invoice amounts - # and usage graphs. Once all of the updates are complete, the backfill's status - # will transition to `reflected`. + # backfill, Orb will asynchronously reflect the updated usage in invoice amounts + # and usage graphs. Once all of the updates are complete, the backfill's status + # will transition to `reflected`. sig do params( backfill_id: String, @@ -129,12 +129,12 @@ module Orb def fetch(backfill_id, request_options: {}); end # Reverting a backfill undoes all the effects of closing the backfill. If the - # backfill is reflected, the status will transition to `pending_revert` while the - # effects of the backfill are undone. Once all effects are undone, the backfill - # will transition to `reverted`. + # backfill is reflected, the status will transition to `pending_revert` while the + # effects of the backfill are undone. Once all effects are undone, the backfill + # will transition to `reverted`. # - # If a backfill is reverted before its closed, no usage will be updated as a - # result of the backfill and it will immediately transition to `reverted`. + # If a backfill is reverted before its closed, no usage will be updated as a + # result of the backfill and it will immediately transition to `reverted`. sig do params( backfill_id: String, diff --git a/rbi/lib/orb/resources/events/volume.rbi b/rbi/lib/orb/resources/events/volume.rbi index b704e7ba..6e585c7b 100644 --- a/rbi/lib/orb/resources/events/volume.rbi +++ b/rbi/lib/orb/resources/events/volume.rbi @@ -5,18 +5,18 @@ module Orb class Events class Volume # This endpoint returns the event volume for an account in a - # [paginated list format](/api-reference/pagination). + # [paginated list format](/api-reference/pagination). # - # The event volume is aggregated by the hour and the - # [timestamp](/api-reference/event/ingest-events) field is used to determine which - # hour an event is associated with. Note, this means that late-arriving events - # increment the volume count for the hour window the timestamp is in, not the - # latest hour window. + # The event volume is aggregated by the hour and the + # [timestamp](/api-reference/event/ingest-events) field is used to determine which + # hour an event is associated with. Note, this means that late-arriving events + # increment the volume count for the hour window the timestamp is in, not the + # latest hour window. # - # Each item in the response contains the count of events aggregated by the hour - # where the start and end time are hour-aligned and in UTC. When a specific - # timestamp is passed in for either start or end time, the response includes the - # hours the timestamp falls in. + # Each item in the response contains the count of events aggregated by the hour + # where the start and end time are hour-aligned and in UTC. When a specific + # timestamp is passed in for either start or end time, the response includes the + # hours the timestamp falls in. sig do params( timeframe_start: Time, @@ -29,19 +29,19 @@ module Orb end def list( # The start of the timeframe, inclusive, in which to return event volume. All - # datetime values are converted to UTC time. If the specified time isn't - # hour-aligned, the response includes the event volume count for the hour the time - # falls in. + # datetime values are converted to UTC time. If the specified time isn't + # hour-aligned, the response includes the event volume count for the hour the time + # falls in. timeframe_start:, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, # The end of the timeframe, exclusive, in which to return event volume. If not - # specified, the current time is used. All datetime values are converted to UTC - # time.If the specified time isn't hour-aligned, the response includes the event - # volumecount for the hour the time falls in. + # specified, the current time is used. All datetime values are converted to UTC + # time.If the specified time isn't hour-aligned, the response includes the event + # volumecount for the hour the time falls in. timeframe_end: nil, request_options: {} ); end diff --git a/rbi/lib/orb/resources/invoice_line_items.rbi b/rbi/lib/orb/resources/invoice_line_items.rbi index ea283476..86a7e8ac 100644 --- a/rbi/lib/orb/resources/invoice_line_items.rbi +++ b/rbi/lib/orb/resources/invoice_line_items.rbi @@ -4,7 +4,7 @@ module Orb module Resources class InvoiceLineItems # This creates a one-off fixed fee invoice line item on an Invoice. This can only - # be done for invoices that are in a `draft` status. + # be done for invoices that are in a `draft` status. sig do params( amount: String, @@ -25,7 +25,7 @@ module Orb # The id of the Invoice to add this line item. invoice_id:, # The item name associated with this line item. If an item with the same name - # exists in Orb, that item will be associated with the line item. + # exists in Orb, that item will be associated with the line item. name:, # The number of units on the line item quantity:, diff --git a/rbi/lib/orb/resources/invoices.rbi b/rbi/lib/orb/resources/invoices.rbi index 83c500a1..777389e9 100644 --- a/rbi/lib/orb/resources/invoices.rbi +++ b/rbi/lib/orb/resources/invoices.rbi @@ -30,41 +30,41 @@ module Orb end def create( # An ISO 4217 currency string. Must be the same as the customer's currency if it - # is set. + # is set. currency:, # Optional invoice date to set. Must be in the past, if not set, `invoice_date` is - # set to the current time in the customer's timezone. + # set to the current time in the customer's timezone. invoice_date:, line_items:, # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of '0' here represents that the - # invoice is due on issue, whereas a value of 30 represents that the customer has - # 30 days to pay the invoice. + # invoices as the date that they are due. A value of '0' here represents that the + # invoice is due on issue, whereas a value of 30 represents that the customer has + # 30 days to pay the invoice. net_terms:, # The id of the `Customer` to create this invoice for. One of `customer_id` and - # `external_customer_id` are required. + # `external_customer_id` are required. customer_id: nil, # An optional discount to attach to the invoice. discount: nil, # The `external_customer_id` of the `Customer` to create this invoice for. One of - # `customer_id` and `external_customer_id` are required. + # `customer_id` and `external_customer_id` are required. external_customer_id: nil, # An optional memo to attach to the invoice. memo: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, # When true, this invoice will automatically be issued upon creation. When false, - # the resulting invoice will require manual review to issue. Defaulted to false. + # the resulting invoice will require manual review to issue. Defaulted to false. will_auto_issue: nil, request_options: {} ); end # This endpoint allows you to update the `metadata` property on an invoice. If you - # pass null for the metadata value, it will clear any existing metadata for that - # invoice. + # pass null for the metadata value, it will clear any existing metadata for that + # invoice. # - # `metadata` can be modified regardless of invoice state. + # `metadata` can be modified regardless of invoice state. sig do params( invoice_id: String, @@ -76,24 +76,24 @@ module Orb def update( invoice_id, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end # This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an - # account in a list format. + # account in a list format. # - # The list of invoices is ordered starting from the most recently issued invoice - # date. The response also includes - # [`pagination_metadata`](/api-reference/pagination), which lets the caller - # retrieve the next page of results if they exist. + # The list of invoices is ordered starting from the most recently issued invoice + # date. The response also includes + # [`pagination_metadata`](/api-reference/pagination), which lets the caller + # retrieve the next page of results if they exist. # - # By default, this only returns invoices that are `issued`, `paid`, or `synced`. + # By default, this only returns invoices that are `issued`, `paid`, or `synced`. # - # When fetching any `draft` invoices, this returns the last-computed invoice - # values for each draft invoice, which may not always be up-to-date since Orb - # regularly refreshes invoices asynchronously. + # When fetching any `draft` invoices, this returns the last-computed invoice + # values for each draft invoice, which may not always be up-to-date since Orb + # regularly refreshes invoices asynchronously. sig do params( amount: T.nilable(String), @@ -124,15 +124,15 @@ module Orb amount_gt: nil, amount_lt: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, customer_id: nil, date_type: nil, due_date: nil, # Filters invoices by their due dates within a specific time range in the past. - # Specify the range as a number followed by 'd' (days) or 'm' (months). For - # example, '7d' filters invoices due in the last 7 days, and '2m' filters those - # due in the last 2 months. + # Specify the range as a number followed by 'd' (days) or 'm' (months). For + # example, '7d' filters invoices due in the last 7 days, and '2m' filters those + # due in the last 2 months. due_date_window: nil, due_date_gt: nil, due_date_lt: nil, @@ -149,7 +149,7 @@ module Orb request_options: {} ); end # This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an - # identifier. + # identifier. sig do params( invoice_id: String, @@ -160,8 +160,8 @@ module Orb def fetch(invoice_id, request_options: {}); end # This endpoint can be used to fetch the upcoming - # [invoice](/core-concepts#invoice) for the current billing period given a - # subscription. + # [invoice](/core-concepts#invoice) for the current billing period given a + # subscription. sig do params( subscription_id: String, @@ -172,11 +172,11 @@ module Orb def fetch_upcoming(subscription_id:, request_options: {}); end # This endpoint allows an eligible invoice to be issued manually. This is only - # possible with invoices where status is `draft`, `will_auto_issue` is false, and - # an `eligible_to_issue_at` is a time in the past. Issuing an invoice could - # possibly trigger side effects, some of which could be customer-visible (e.g. - # sending emails, auto-collecting payment, syncing the invoice to external - # providers, etc). + # possible with invoices where status is `draft`, `will_auto_issue` is false, and + # an `eligible_to_issue_at` is a time in the past. Issuing an invoice could + # possibly trigger side effects, some of which could be customer-visible (e.g. + # sending emails, auto-collecting payment, syncing the invoice to external + # providers, etc). sig do params( invoice_id: String, @@ -188,15 +188,15 @@ module Orb def issue( invoice_id, # If true, the invoice will be issued synchronously. If false, the invoice will be - # issued asynchronously. The synchronous option is only available for invoices - # that have no usage fees. If the invoice is configured to sync to an external - # provider, a successful response from this endpoint guarantees the invoice is - # present in the provider. + # issued asynchronously. The synchronous option is only available for invoices + # that have no usage fees. If the invoice is configured to sync to an external + # provider, a successful response from this endpoint guarantees the invoice is + # present in the provider. synchronous: nil, request_options: {} ); end # This endpoint allows an invoice's status to be set the `paid` status. This can - # only be done to invoices that are in the `issued` status. + # only be done to invoices that are in the `issued` status. sig do params( invoice_id: String, @@ -218,7 +218,7 @@ module Orb request_options: {} ); end # This endpoint collects payment for an invoice using the customer's default - # payment method. This action can only be taken on invoices with status "issued". + # payment method. This action can only be taken on invoices with status "issued". sig do params( invoice_id: String, @@ -229,16 +229,16 @@ module Orb def pay(invoice_id, request_options: {}); end # This endpoint allows an invoice's status to be set the `void` status. This can - # only be done to invoices that are in the `issued` status. + # only be done to invoices that are in the `issued` status. # - # If the associated invoice has used the customer balance to change the amount - # due, the customer balance operation will be reverted. For example, if the - # invoice used $10 of customer balance, that amount will be added back to the - # customer balance upon voiding. + # If the associated invoice has used the customer balance to change the amount + # due, the customer balance operation will be reverted. For example, if the + # invoice used $10 of customer balance, that amount will be added back to the + # customer balance upon voiding. # - # If the invoice was used to purchase a credit block, but the invoice is not yet - # paid, the credit block will be voided. If the invoice was created due to a - # top-up, the top-up will be disabled. + # If the invoice was used to purchase a credit block, but the invoice is not yet + # paid, the credit block will be voided. If the invoice was created due to a + # top-up, the top-up will be disabled. sig do params( invoice_id: String, diff --git a/rbi/lib/orb/resources/items.rbi b/rbi/lib/orb/resources/items.rbi index 4790c2df..3a18500b 100644 --- a/rbi/lib/orb/resources/items.rbi +++ b/rbi/lib/orb/resources/items.rbi @@ -26,7 +26,7 @@ module Orb def update(item_id, external_connections: nil, name: nil, request_options: {}); end # This endpoint returns a list of all Items, ordered in descending order by - # creation time. + # creation time. sig do params( cursor: T.nilable(String), @@ -37,7 +37,7 @@ module Orb end def list( # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, diff --git a/rbi/lib/orb/resources/metrics.rbi b/rbi/lib/orb/resources/metrics.rbi index c246f8fb..1186c03b 100644 --- a/rbi/lib/orb/resources/metrics.rbi +++ b/rbi/lib/orb/resources/metrics.rbi @@ -4,8 +4,8 @@ module Orb module Resources class Metrics # This endpoint is used to create a [metric](/core-concepts###metric) using a SQL - # string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a - # description of constructing SQL queries with examples. + # string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a + # description of constructing SQL queries with examples. sig do params( description: T.nilable(String), @@ -27,14 +27,14 @@ module Orb # A sql string defining the metric. sql:, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end # This endpoint allows you to update the `metadata` property on a metric. If you - # pass `null` for the metadata value, it will clear any existing metadata for that - # invoice. + # pass `null` for the metadata value, it will clear any existing metadata for that + # invoice. sig do params( metric_id: String, @@ -46,14 +46,14 @@ module Orb def update( metric_id, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end # This endpoint is used to fetch [metric](/core-concepts##metric) details given a - # metric identifier. It returns information about the metrics including its name, - # description, and item. + # metric identifier. It returns information about the metrics including its name, + # description, and item. sig do params( created_at_gt: T.nilable(Time), @@ -72,14 +72,14 @@ module Orb created_at_lt: nil, created_at_lte: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} ); end # This endpoint is used to list [metrics](/core-concepts#metric). It returns - # information about the metrics including its name, description, and item. + # information about the metrics including its name, description, and item. sig do params( metric_id: String, diff --git a/rbi/lib/orb/resources/plans.rbi b/rbi/lib/orb/resources/plans.rbi index 67f00804..862a2dab 100644 --- a/rbi/lib/orb/resources/plans.rbi +++ b/rbi/lib/orb/resources/plans.rbi @@ -52,32 +52,32 @@ module Orb end def create( # An ISO 4217 currency string for invoices generated by subscriptions on this - # plan. + # plan. currency:, name:, # Prices for this plan. If the plan has phases, this includes prices across all - # phases of the plan. + # phases of the plan. prices:, # Free-form text which is available on the invoice PDF and the Orb invoice portal. default_invoice_memo: nil, external_plan_id: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. net_terms: nil, # The status of the plan to create (either active or draft). If not specified, - # this defaults to active. + # this defaults to active. status: nil, request_options: {} ); end # This endpoint can be used to update the `external_plan_id`, and `metadata` of an - # existing plan. + # existing plan. # - # Other fields on a customer are currently immutable. + # Other fields on a customer are currently immutable. sig do params( plan_id: String, @@ -90,20 +90,20 @@ module Orb def update( plan_id, # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. external_plan_id: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end # This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for - # an account in a list format. The list of plans is ordered starting from the most - # recently created plan. The response also includes - # [`pagination_metadata`](/api-reference/pagination), which lets the caller - # retrieve the next page of results if they exist. + # an account in a list format. The list of plans is ordered starting from the most + # recently created plan. The response also includes + # [`pagination_metadata`](/api-reference/pagination), which lets the caller + # retrieve the next page of results if they exist. sig do params( created_at_gt: T.nilable(Time), @@ -123,7 +123,7 @@ module Orb created_at_lt: nil, created_at_lte: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, @@ -132,22 +132,22 @@ module Orb request_options: {} ); end # This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details - # given a plan identifier. It returns information about the prices included in the - # plan and their configuration, as well as the product that the plan is attached - # to. + # given a plan identifier. It returns information about the prices included in the + # plan and their configuration, as well as the product that the plan is attached + # to. # - # ## Serialized prices + # ## Serialized prices # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given [Price](/core-concepts#plan-and-price) - # object. The `model_type` field determines the key for the configuration object - # that is present. A detailed explanation of price types can be found in the - # [Price schema](/core-concepts#plan-and-price). + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given [Price](/core-concepts#plan-and-price) + # object. The `model_type` field determines the key for the configuration object + # that is present. A detailed explanation of price types can be found in the + # [Price schema](/core-concepts#plan-and-price). # - # ## Phases + # ## Phases # - # Orb supports plan phases, also known as contract ramps. For plans with phases, - # the serialized prices refer to all prices across all phases. + # Orb supports plan phases, also known as contract ramps. For plans with phases, + # the serialized prices refer to all prices across all phases. sig do params( plan_id: String, diff --git a/rbi/lib/orb/resources/plans/external_plan_id.rbi b/rbi/lib/orb/resources/plans/external_plan_id.rbi index 0d49dd48..b3bc1a46 100644 --- a/rbi/lib/orb/resources/plans/external_plan_id.rbi +++ b/rbi/lib/orb/resources/plans/external_plan_id.rbi @@ -5,9 +5,9 @@ module Orb class Plans class ExternalPlanID # This endpoint can be used to update the `external_plan_id`, and `metadata` of an - # existing plan. + # existing plan. # - # Other fields on a customer are currently immutable. + # Other fields on a customer are currently immutable. sig do params( other_external_plan_id: String, @@ -20,31 +20,31 @@ module Orb def update( other_external_plan_id, # An optional user-defined ID for this plan resource, used throughout the system - # as an alias for this Plan. Use this field to identify a plan by an existing - # identifier in your system. + # as an alias for this Plan. Use this field to identify a plan by an existing + # identifier in your system. external_plan_id: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end # This endpoint is used to fetch [plan](/core-concepts##plan-and-price) details - # given an external_plan_id identifier. It returns information about the prices - # included in the plan and their configuration, as well as the product that the - # plan is attached to. + # given an external_plan_id identifier. It returns information about the prices + # included in the plan and their configuration, as well as the product that the + # plan is attached to. # - # If multiple plans are found to contain the specified external_plan_id, the - # active plans will take priority over archived ones, and among those, the - # endpoint will return the most recently created plan. + # If multiple plans are found to contain the specified external_plan_id, the + # active plans will take priority over archived ones, and among those, the + # endpoint will return the most recently created plan. # - # ## Serialized prices + # ## Serialized prices # - # Orb supports a few different pricing models out of the box. Each of these models - # is serialized differently in a given [Price](/core-concepts#plan-and-price) - # object. The `model_type` field determines the key for the configuration object - # that is present. A detailed explanation of price types can be found in the - # [Price schema](/core-concepts#plan-and-price). " + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given [Price](/core-concepts#plan-and-price) + # object. The `model_type` field determines the key for the configuration object + # that is present. A detailed explanation of price types can be found in the + # [Price schema](/core-concepts#plan-and-price). " sig do params( external_plan_id: String, diff --git a/rbi/lib/orb/resources/prices.rbi b/rbi/lib/orb/resources/prices.rbi index cb2b44ab..762a8759 100644 --- a/rbi/lib/orb/resources/prices.rbi +++ b/rbi/lib/orb/resources/prices.rbi @@ -7,15 +7,15 @@ module Orb attr_reader :external_price_id # This endpoint is used to create a [price](/product-catalog/price-configuration). - # A price created using this endpoint is always an add-on, meaning that it’s not - # associated with a specific plan and can instead be individually added to - # subscriptions, including subscriptions on different plans. + # A price created using this endpoint is always an add-on, meaning that it’s not + # associated with a specific plan and can instead be individually added to + # subscriptions, including subscriptions on different plans. # - # An `external_price_id` can be optionally specified as an alias to allow - # ergonomic interaction with prices in the Orb API. + # An `external_price_id` can be optionally specified as an alias to allow + # ergonomic interaction with prices in the Orb API. # - # See the [Price resource](/product-catalog/price-configuration) for the - # specification of different price model configurations possible in this endpoint. + # See the [Price resource](/product-catalog/price-configuration) for the + # specification of different price model configurations possible in this endpoint. sig do params( cadence: Orb::Models::PriceCreateParams::Cadence::OrSymbol, @@ -134,35 +134,35 @@ module Orb scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, # The id of the billable metric for the price. Only needed if the price is - # usage-based. + # usage-based. billable_metric_id: nil, # If the Price represents a fixed cost, the price will be billed in-advance if - # this is true, and in-arrears if this is false. + # this is true, and in-arrears if this is false. billed_in_advance: nil, # For custom cadence: specifies the duration of the billing period in days or - # months. + # months. billing_cycle_configuration: nil, # The per unit conversion rate of the price currency to the invoicing currency. conversion_rate: nil, # An alias for the price. external_price_id: nil, # If the Price represents a fixed cost, this represents the quantity of units - # applied. + # applied. fixed_price_quantity: nil, # The property used to group this price on an invoice invoice_grouping_key: nil, # Within each billing cycle, specifies the cadence at which invoices are produced. - # If unspecified, a single invoice is produced per billing cycle. + # If unspecified, a single invoice is produced per billing cycle. invoicing_cycle_configuration: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end # This endpoint allows you to update the `metadata` property on a price. If you - # pass null for the metadata value, it will clear any existing metadata for that - # price. + # pass null for the metadata value, it will clear any existing metadata for that + # price. sig do params( price_id: String, @@ -205,13 +205,13 @@ module Orb def update( price_id, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end # This endpoint is used to list all add-on prices created using the - # [price creation endpoint](/api-reference/price/create-price). + # [price creation endpoint](/api-reference/price/create-price). sig do params( cursor: T.nilable(String), @@ -255,33 +255,33 @@ module Orb end def list( # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, request_options: {} ); end # This endpoint is used to evaluate the output of a price for a given customer and - # time range. It enables filtering and grouping the output using - # [computed properties](/extensibility/advanced-metrics#computed-properties), - # supporting the following workflows: + # time range. It enables filtering and grouping the output using + # [computed properties](/extensibility/advanced-metrics#computed-properties), + # supporting the following workflows: # - # 1. Showing detailed usage and costs to the end customer. - # 2. Auditing subtotals on invoice line items. + # 1. Showing detailed usage and costs to the end customer. + # 2. Auditing subtotals on invoice line items. # - # For these workflows, the expressiveness of computed properties in both the - # filters and grouping is critical. For example, if you'd like to show your - # customer their usage grouped by hour and another property, you can do so with - # the following `grouping_keys`: - # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd - # like to examine a customer's usage for a specific property value, you can do so - # with the following `filter`: - # `my_property = 'foo' AND my_other_property = 'bar'`. + # For these workflows, the expressiveness of computed properties in both the + # filters and grouping is critical. For example, if you'd like to show your + # customer their usage grouped by hour and another property, you can do so with + # the following `grouping_keys`: + # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd + # like to examine a customer's usage for a specific property value, you can do so + # with the following `filter`: + # `my_property = 'foo' AND my_other_property = 'bar'`. # - # By default, the start of the time range must be no more than 100 days ago and - # the length of the results must be no greater than 1000. Note that this is a POST - # endpoint rather than a GET endpoint because it employs a JSON body rather than - # query parameters. + # By default, the start of the time range must be no more than 100 days ago and + # the length of the results must be no greater than 1000. Note that this is a POST + # endpoint rather than a GET endpoint because it employs a JSON body rather than + # query parameters. sig do params( price_id: String, @@ -306,12 +306,12 @@ module Orb # The external customer ID of the customer to which this evaluation is scoped. external_customer_id: nil, # A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the underlying billable metric + # [computed property](/extensibility/advanced-metrics#computed-properties) used to + # filter the underlying billable metric filter: nil, # Properties (or - # [computed properties](/extensibility/advanced-metrics#computed-properties)) used - # to group the underlying billable metric + # [computed properties](/extensibility/advanced-metrics#computed-properties)) used + # to group the underlying billable metric grouping_keys: nil, request_options: {} ); end diff --git a/rbi/lib/orb/resources/prices/external_price_id.rbi b/rbi/lib/orb/resources/prices/external_price_id.rbi index 228184c2..90d87bc2 100644 --- a/rbi/lib/orb/resources/prices/external_price_id.rbi +++ b/rbi/lib/orb/resources/prices/external_price_id.rbi @@ -5,8 +5,8 @@ module Orb class Prices class ExternalPriceID # This endpoint allows you to update the `metadata` property on a price. If you - # pass null for the metadata value, it will clear any existing metadata for that - # price. + # pass null for the metadata value, it will clear any existing metadata for that + # price. sig do params( external_price_id: String, @@ -49,14 +49,14 @@ module Orb def update( external_price_id, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, request_options: {} ); end # This endpoint returns a price given an external price id. See the - # [price creation API](/api-reference/price/create-price) for more information - # about external price aliases. + # [price creation API](/api-reference/price/create-price) for more information + # about external price aliases. sig do params( external_price_id: String, diff --git a/rbi/lib/orb/resources/subscriptions.rbi b/rbi/lib/orb/resources/subscriptions.rbi index e88e0ad0..5801a95d 100644 --- a/rbi/lib/orb/resources/subscriptions.rbi +++ b/rbi/lib/orb/resources/subscriptions.rbi @@ -4,261 +4,261 @@ module Orb module Resources class Subscriptions # A subscription represents the purchase of a plan by a customer. The customer is - # identified by either the `customer_id` or the `external_customer_id`, and - # exactly one of these fields must be provided. - # - # By default, subscriptions begin on the day that they're created and renew - # automatically for each billing cycle at the cadence that's configured in the - # plan definition. - # - # The default configuration for subscriptions in Orb is **In-advance billing** and - # **Beginning of month alignment** (see - # [Subscription](/core-concepts##subscription) for more details). - # - # In order to change the alignment behavior, Orb also supports billing - # subscriptions on the day of the month they are created. If - # `align_billing_with_subscription_start_date = true` is specified, subscriptions - # have billing cycles that are aligned with their `start_date`. For example, a - # subscription that begins on January 15th will have a billing cycle from January - # 15th to February 15th. Every subsequent billing cycle will continue to start and - # invoice on the 15th. - # - # If the "day" value is greater than the number of days in the month, the next - # billing cycle will start at the end of the month. For example, if the start_date - # is January 31st, the next billing cycle will start on February 28th. - # - # If a customer was created with a currency, Orb only allows subscribing the - # customer to a plan with a matching `invoicing_currency`. If the customer does - # not have a currency set, on subscription creation, we set the customer's - # currency to be the `invoicing_currency` of the plan. - # - # ## Customize your customer's subscriptions - # - # Prices and adjustments in a plan can be added, removed, or replaced for the - # subscription being created. This is useful when a customer has prices that - # differ from the default prices for a specific plan. - # - # - # This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your - # Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans) - # - # - # ### Adding Prices - # - # To add prices, provide a list of objects with the key `add_prices`. An object in - # the list must specify an existing add-on price with a `price_id` or - # `external_price_id` field, or create a new add-on price by including an object - # with the key `price`, identical to what would be used in the request body for - # the [create price endpoint](/api-reference/price/create-price). See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations possible in this object. - # - # If the plan has phases, each object in the list must include a number with - # `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. - # - # An object in the list can specify an optional `minimum_amount`, - # `maximum_amount`, or `discounts`. This will create adjustments which apply only - # to this price. - # - # Additionally, an object in the list can specify an optional `reference_id`. This - # ID can be used to reference this price when - # [adding an adjustment](#adding-adjustments) in the same API call. However the ID - # is _transient_ and cannot be used to refer to the price in future API calls. - # - # ### Removing Prices - # - # To remove prices, provide a list of objects with the key `remove_prices`. An - # object in the list must specify a plan price with either a `price_id` or - # `external_price_id` field. - # - # ### Replacing Prices - # - # To replace prices, provide a list of objects with the key `replace_prices`. An - # object in the list must specify a plan price to replace with the - # `replaces_price_id` key, and it must specify a price to replace it with by - # either referencing an existing add-on price with a `price_id` or - # `external_price_id` field, or by creating a new add-on price by including an - # object with the key `price`, identical to what would be used in the request body - # for the [create price endpoint](/api-reference/price/create-price). See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations possible in this object. - # - # For fixed fees, an object in the list can supply a `fixed_price_quantity` - # instead of a `price`, `price_id`, or `external_price_id` field. This will update - # only the quantity for the price, similar to the - # [Update price quantity](/api-reference/subscription/update-price-quantity) - # endpoint. - # - # The replacement price will have the same phase, if applicable, and the same - # start and end dates as the price it replaces. - # - # An object in the list can specify an optional `minimum_amount`, - # `maximum_amount`, or `discounts`. This will create adjustments which apply only - # to this price. - # - # Additionally, an object in the list can specify an optional `reference_id`. This - # ID can be used to reference the replacement price when - # [adding an adjustment](#adding-adjustments) in the same API call. However the ID - # is _transient_ and cannot be used to refer to the price in future API calls. - # - # ### Adding adjustments - # - # To add adjustments, provide a list of objects with the key `add_adjustments`. An - # object in the list must include an object with the key `adjustment`, identical - # to the adjustment object in the - # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - # - # If the plan has phases, each object in the list must include a number with - # `plan_phase_order` key to indicate which phase the adjustment should be added - # 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. - # - # ### Removing adjustments - # - # To remove adjustments, provide a list of objects with the key - # `remove_adjustments`. An object in the list must include a key, `adjustment_id`, - # with the ID of the adjustment to be removed. - # - # ### Replacing adjustments - # - # To replace adjustments, provide a list of objects with the key - # `replace_adjustments`. An object in the list must specify a plan adjustment to - # replace with the `replaces_adjustment_id` key, and it must specify an adjustment - # to replace it with by including an object with the key `adjustment`, identical - # to the adjustment object in the - # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - # - # The replacement adjustment will have the same phase, if applicable, and the same - # start and end dates as the adjustment it replaces. - # - # ## Price overrides (DEPRECATED) - # - # - # Price overrides are being phased out in favor adding/removing/replacing prices. (See - # [Customize your customer's subscriptions](/api-reference/subscription/create-subscription)) - # - # - # Price overrides are used to update some or all prices in a plan for the specific - # subscription being created. This is useful when a new customer has negotiated a - # rate that is unique to the customer. - # - # To override prices, provide a list of objects with the key `price_overrides`. - # The price object in the list of overrides is expected to contain the existing - # price id, the `model_type` and configuration. (See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations.) The numerical values can be updated, but - # the billable metric, cadence, type, and name of a price can not be overridden. - # - # ### Maximums and Minimums - # - # Minimums and maximums, much like price overrides, can be useful when a new - # customer has negotiated a new or different minimum or maximum spend cap than the - # default for a given price. If one exists for a price and null is provided for - # the minimum/maximum override on creation, then there will be no minimum/maximum - # on the new subscription. If no value is provided, then the default price maximum - # or minimum is used. - # - # To add a minimum for a specific price, add `minimum_amount` to the specific - # price in the `price_overrides` object. - # - # To add a maximum for a specific price, add `maximum_amount` to the specific - # price in the `price_overrides` object. - # - # ### Minimum override example - # - # Price minimum override example: - # - # ```json - # { - # ... - # "id": "price_id", - # "model_type": "unit", - # "unit_config": { - # "unit_amount": "0.50" - # }, - # "minimum_amount": "100.00" - # ... - # } - # ``` - # - # Removing an existing minimum example - # - # ```json - # { - # ... - # "id": "price_id", - # "model_type": "unit", - # "unit_config": { - # "unit_amount": "0.50" - # }, - # "minimum_amount": null - # ... - # } - # ``` - # - # ### Discounts - # - # Discounts, like price overrides, can be useful when a new customer has - # negotiated a new or different discount than the default for a price. If a - # discount exists for a price and a null discount is provided on creation, then - # there will be no discount on the new subscription. - # - # To add a discount for a specific price, add `discount` to the price in the - # `price_overrides` object. Discount should be a dictionary of the format: - # - # ```ts - # { - # "discount_type": "amount" | "percentage" | "usage", - # "amount_discount": string, - # "percentage_discount": string, - # "usage_discount": string - # } - # ``` - # - # where either `amount_discount`, `percentage_discount`, or `usage_discount` is - # provided. - # - # Price discount example - # - # ```json - # { - # ... - # "id": "price_id", - # "model_type": "unit", - # "unit_config": { - # "unit_amount": "0.50" - # }, - # "discount": {"discount_type": "amount", "amount_discount": "175"}, - # } - # ``` - # - # Removing an existing discount example - # - # ```json - # { - # "customer_id": "customer_id", - # "plan_id": "plan_id", - # "discount": null, - # "price_overrides": [ ... ] - # ... - # } - # ``` - # - # ## Threshold Billing - # - # Orb supports invoicing for a subscription when a preconfigured usage threshold - # is hit. To enable threshold billing, pass in an `invoicing_threshold`, which is - # specified in the subscription's invoicing currency, when creating a - # subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit - # $10.00 for a subscription that invoices in USD. + # identified by either the `customer_id` or the `external_customer_id`, and + # exactly one of these fields must be provided. + # + # By default, subscriptions begin on the day that they're created and renew + # automatically for each billing cycle at the cadence that's configured in the + # plan definition. + # + # The default configuration for subscriptions in Orb is **In-advance billing** and + # **Beginning of month alignment** (see + # [Subscription](/core-concepts##subscription) for more details). + # + # In order to change the alignment behavior, Orb also supports billing + # subscriptions on the day of the month they are created. If + # `align_billing_with_subscription_start_date = true` is specified, subscriptions + # have billing cycles that are aligned with their `start_date`. For example, a + # subscription that begins on January 15th will have a billing cycle from January + # 15th to February 15th. Every subsequent billing cycle will continue to start and + # invoice on the 15th. + # + # If the "day" value is greater than the number of days in the month, the next + # billing cycle will start at the end of the month. For example, if the start_date + # is January 31st, the next billing cycle will start on February 28th. + # + # If a customer was created with a currency, Orb only allows subscribing the + # customer to a plan with a matching `invoicing_currency`. If the customer does + # not have a currency set, on subscription creation, we set the customer's + # currency to be the `invoicing_currency` of the plan. + # + # ## Customize your customer's subscriptions + # + # Prices and adjustments in a plan can be added, removed, or replaced for the + # subscription being created. This is useful when a customer has prices that + # differ from the default prices for a specific plan. + # + # + # This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your + # Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans) + # + # + # ### Adding Prices + # + # To add prices, provide a list of objects with the key `add_prices`. An object in + # the list must specify an existing add-on price with a `price_id` or + # `external_price_id` field, or create a new add-on price by including an object + # with the key `price`, identical to what would be used in the request body for + # the [create price endpoint](/api-reference/price/create-price). See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations possible in this object. + # + # If the plan has phases, each object in the list must include a number with + # `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. + # + # An object in the list can specify an optional `minimum_amount`, + # `maximum_amount`, or `discounts`. This will create adjustments which apply only + # to this price. + # + # Additionally, an object in the list can specify an optional `reference_id`. This + # ID can be used to reference this price when + # [adding an adjustment](#adding-adjustments) in the same API call. However the ID + # is _transient_ and cannot be used to refer to the price in future API calls. + # + # ### Removing Prices + # + # To remove prices, provide a list of objects with the key `remove_prices`. An + # object in the list must specify a plan price with either a `price_id` or + # `external_price_id` field. + # + # ### Replacing Prices + # + # To replace prices, provide a list of objects with the key `replace_prices`. An + # object in the list must specify a plan price to replace with the + # `replaces_price_id` key, and it must specify a price to replace it with by + # either referencing an existing add-on price with a `price_id` or + # `external_price_id` field, or by creating a new add-on price by including an + # object with the key `price`, identical to what would be used in the request body + # for the [create price endpoint](/api-reference/price/create-price). See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations possible in this object. + # + # For fixed fees, an object in the list can supply a `fixed_price_quantity` + # instead of a `price`, `price_id`, or `external_price_id` field. This will update + # only the quantity for the price, similar to the + # [Update price quantity](/api-reference/subscription/update-price-quantity) + # endpoint. + # + # The replacement price will have the same phase, if applicable, and the same + # start and end dates as the price it replaces. + # + # An object in the list can specify an optional `minimum_amount`, + # `maximum_amount`, or `discounts`. This will create adjustments which apply only + # to this price. + # + # Additionally, an object in the list can specify an optional `reference_id`. This + # ID can be used to reference the replacement price when + # [adding an adjustment](#adding-adjustments) in the same API call. However the ID + # is _transient_ and cannot be used to refer to the price in future API calls. + # + # ### Adding adjustments + # + # To add adjustments, provide a list of objects with the key `add_adjustments`. An + # object in the list must include an object with the key `adjustment`, identical + # to the adjustment object in the + # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). + # + # If the plan has phases, each object in the list must include a number with + # `plan_phase_order` key to indicate which phase the adjustment should be added + # 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. + # + # ### Removing adjustments + # + # To remove adjustments, provide a list of objects with the key + # `remove_adjustments`. An object in the list must include a key, `adjustment_id`, + # with the ID of the adjustment to be removed. + # + # ### Replacing adjustments + # + # To replace adjustments, provide a list of objects with the key + # `replace_adjustments`. An object in the list must specify a plan adjustment to + # replace with the `replaces_adjustment_id` key, and it must specify an adjustment + # to replace it with by including an object with the key `adjustment`, identical + # to the adjustment object in the + # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). + # + # The replacement adjustment will have the same phase, if applicable, and the same + # start and end dates as the adjustment it replaces. + # + # ## Price overrides (DEPRECATED) + # + # + # Price overrides are being phased out in favor adding/removing/replacing prices. (See + # [Customize your customer's subscriptions](/api-reference/subscription/create-subscription)) + # + # + # Price overrides are used to update some or all prices in a plan for the specific + # subscription being created. This is useful when a new customer has negotiated a + # rate that is unique to the customer. + # + # To override prices, provide a list of objects with the key `price_overrides`. + # The price object in the list of overrides is expected to contain the existing + # price id, the `model_type` and configuration. (See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations.) The numerical values can be updated, but + # the billable metric, cadence, type, and name of a price can not be overridden. + # + # ### Maximums and Minimums + # + # Minimums and maximums, much like price overrides, can be useful when a new + # customer has negotiated a new or different minimum or maximum spend cap than the + # default for a given price. If one exists for a price and null is provided for + # the minimum/maximum override on creation, then there will be no minimum/maximum + # on the new subscription. If no value is provided, then the default price maximum + # or minimum is used. + # + # To add a minimum for a specific price, add `minimum_amount` to the specific + # price in the `price_overrides` object. + # + # To add a maximum for a specific price, add `maximum_amount` to the specific + # price in the `price_overrides` object. + # + # ### Minimum override example + # + # Price minimum override example: + # + # ```json + # { + # ... + # "id": "price_id", + # "model_type": "unit", + # "unit_config": { + # "unit_amount": "0.50" + # }, + # "minimum_amount": "100.00" + # ... + # } + # ``` + # + # Removing an existing minimum example + # + # ```json + # { + # ... + # "id": "price_id", + # "model_type": "unit", + # "unit_config": { + # "unit_amount": "0.50" + # }, + # "minimum_amount": null + # ... + # } + # ``` + # + # ### Discounts + # + # Discounts, like price overrides, can be useful when a new customer has + # negotiated a new or different discount than the default for a price. If a + # discount exists for a price and a null discount is provided on creation, then + # there will be no discount on the new subscription. + # + # To add a discount for a specific price, add `discount` to the price in the + # `price_overrides` object. Discount should be a dictionary of the format: + # + # ```ts + # { + # "discount_type": "amount" | "percentage" | "usage", + # "amount_discount": string, + # "percentage_discount": string, + # "usage_discount": string + # } + # ``` + # + # where either `amount_discount`, `percentage_discount`, or `usage_discount` is + # provided. + # + # Price discount example + # + # ```json + # { + # ... + # "id": "price_id", + # "model_type": "unit", + # "unit_config": { + # "unit_amount": "0.50" + # }, + # "discount": {"discount_type": "amount", "amount_discount": "175"}, + # } + # ``` + # + # Removing an existing discount example + # + # ```json + # { + # "customer_id": "customer_id", + # "plan_id": "plan_id", + # "discount": null, + # "price_overrides": [ ... ] + # ... + # } + # ``` + # + # ## Threshold Billing + # + # Orb supports invoicing for a subscription when a preconfigured usage threshold + # is hit. To enable threshold billing, pass in an `invoicing_threshold`, which is + # specified in the subscription's invoicing currency, when creating a + # subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit + # $10.00 for a subscription that invoices in USD. sig do params( add_adjustments: T.nilable(T::Array[T.any(Orb::Models::SubscriptionCreateParams::AddAdjustment, Orb::Internal::AnyHash)]), @@ -304,92 +304,92 @@ module Orb end def create( # Additional adjustments to be added to the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) add_adjustments: nil, # Additional prices to be added to the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) add_prices: nil, align_billing_with_subscription_start_date: nil, # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. If not specified, this - # defaults to the behavior configured for this customer. + # charged with the saved payment method on the due date. If not specified, this + # defaults to the behavior configured for this customer. auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, # Redemption code to be used for this subscription. If the coupon cannot be found - # by its redemption code, or cannot be redeemed, an error response will be - # returned and the subscription creation or plan change will not be scheduled. + # by its redemption code, or cannot be redeemed, an error response will be + # returned and the subscription creation or plan change will not be scheduled. coupon_redemption_code: nil, credits_overage_rate: nil, customer_id: nil, # Determines the default memo on this subscription's invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, # The external_plan_id of the plan that the given subscription should be switched - # to. Note that either this property or `plan_id` must be specified. + # to. Note that either this property or `plan_id` must be specified. external_plan_id: nil, # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. filter: nil, # The phase of the plan to start with initial_phase_order: nil, # When this subscription's accrued usage reaches this threshold, an invoice will - # be issued for the subscription. If not specified, invoices will only be issued - # at the end of the billing period. + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. invoicing_threshold: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. If not provided, this defaults to the value specified in the plan. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. If not provided, this defaults to the value specified in the plan. net_terms: nil, per_credit_overage_amount: nil, # The plan that the given subscription should be switched to. Note that either - # this property or `external_plan_id` must be specified. + # this property or `external_plan_id` must be specified. plan_id: nil, # Specifies which version of the plan to subscribe to. If null, the default - # version will be used. + # version will be used. plan_version_number: nil, # Optionally provide a list of overrides for prices on the plan price_overrides: nil, # Plan adjustments to be removed from the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) remove_adjustments: nil, # Plan prices to be removed from the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) remove_prices: nil, # Plan adjustments to be replaced with additional adjustments on the subscription. - # (Only available for accounts that have migrated off of legacy subscription - # overrides) + # (Only available for accounts that have migrated off of legacy subscription + # overrides) replace_adjustments: nil, # Plan prices to be replaced with additional prices on the subscription. (Only - # available for accounts that have migrated off of legacy subscription overrides) + # available for accounts that have migrated off of legacy subscription overrides) replace_prices: nil, start_date: nil, # The duration of the trial period in days. If not provided, this defaults to the - # value specified in the plan. If `0` is provided, the trial on the plan will be - # skipped. + # value specified in the plan. If `0` is provided, the trial on the plan will be + # skipped. trial_duration_days: nil, # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. usage_customer_ids: nil, request_options: {} ); end # This endpoint can be used to update the `metadata`, `net terms`, - # `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties - # on a subscription. + # `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties + # on a subscription. sig do params( subscription_id: String, @@ -405,36 +405,36 @@ module Orb def update( subscription_id, # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. This property defaults to - # the plan's behavior. + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. auto_collection: nil, # Determines the default memo on this subscription's invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. default_invoice_memo: nil, # When this subscription's accrued usage reaches this threshold, an invoice will - # be issued for the subscription. If not specified, invoices will only be issued - # at the end of the billing period. + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. invoicing_threshold: nil, # User-specified key/value pairs for the resource. Individual keys can be removed - # by setting the value to `null`, and the entire metadata mapping can be cleared - # by setting `metadata` to `null`. + # by setting the value to `null`, and the entire metadata mapping can be cleared + # by setting `metadata` to `null`. metadata: nil, # Determines the difference between the invoice issue date for subscription - # invoices as the date that they are due. A value of `0` here represents that the - # invoice is due on issue, whereas a value of `30` represents that the customer - # has a month to pay the invoice. + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. net_terms: nil, request_options: {} ); end # This endpoint returns a list of all subscriptions for an account as a - # [paginated](/api-reference/pagination) list, ordered starting from the most - # recently created subscription. For a full discussion of the subscription - # resource, see [Subscription](/core-concepts##subscription). - # - # Subscriptions can be filtered for a specific customer by using either the - # customer_id or external_customer_id query parameters. To filter subscriptions - # for multiple customers, use the customer_id[] or external_customer_id[] query - # parameters. + # [paginated](/api-reference/pagination) list, ordered starting from the most + # recently created subscription. For a full discussion of the subscription + # resource, see [Subscription](/core-concepts##subscription). + # + # Subscriptions can be filtered for a specific customer by using either the + # customer_id or external_customer_id query parameters. To filter subscriptions + # for multiple customers, use the customer_id[] or external_customer_id[] query + # parameters. sig do params( created_at_gt: T.nilable(Time), @@ -456,7 +456,7 @@ module Orb created_at_lt: nil, created_at_lte: nil, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, customer_id: nil, external_customer_id: nil, @@ -466,66 +466,66 @@ module Orb request_options: {} ); end # This endpoint can be used to cancel an existing subscription. It returns the - # serialized subscription object with an `end_date` parameter that signifies when - # the subscription will transition to an ended state. - # - # The body parameter `cancel_option` determines the cancellation behavior. Orb - # supports three cancellation options: - # - # - `end_of_subscription_term`: stops the subscription from auto-renewing. - # Subscriptions that have been cancelled with this option can still incur - # charges for the remainder of their term: - # - # - Issuing this cancellation request for a monthly subscription will keep the - # subscription active until the start of the subsequent month, and potentially - # issue an invoice for any usage charges incurred in the intervening period. - # - Issuing this cancellation request for a quarterly subscription will keep the - # subscription active until the end of the quarter and potentially issue an - # invoice for any usage charges incurred in the intervening period. - # - Issuing this cancellation request for a yearly subscription will keep the - # subscription active for the full year. For example, a yearly subscription - # starting on 2021-11-01 and cancelled on 2021-12-08 will remain active until - # 2022-11-01 and potentially issue charges in the intervening months for any - # recurring monthly usage charges in its plan. - # - **Note**: If a subscription's plan contains prices with difference cadences, - # the end of term date will be determined by the largest cadence value. For - # example, cancelling end of term for a subscription with a quarterly fixed - # fee with a monthly usage fee will result in the subscription ending at the - # end of the quarter. - # - # - `immediate`: ends the subscription immediately, setting the `end_date` to the - # current time: - # - # - Subscriptions that have been cancelled with this option will be invoiced - # immediately. This invoice will include any usage fees incurred in the - # billing period up to the cancellation, along with any prorated recurring - # fees for the billing period, if applicable. - # - **Note**: If the subscription has a recurring fee that was paid in-advance, - # the prorated amount for the remaining time period will be added to the - # [customer's balance](list-balance-transactions) upon immediate cancellation. - # However, if the customer is ineligible to use the customer balance, the - # subscription cannot be cancelled immediately. - # - # - `requested_date`: ends the subscription on a specified date, which requires a - # `cancellation_date` to be passed in. If no timezone is provided, the - # customer's timezone is used. For example, a subscription starting on January - # 1st with a monthly price can be set to be cancelled on the first of any month - # after January 1st (e.g. March 1st, April 1st, May 1st). A subscription with - # multiple prices with different cadences defines the "term" to be the highest - # cadence of the prices. - # - # Upcoming subscriptions are only eligible for immediate cancellation, which will - # set the `end_date` equal to the `start_date` upon cancellation. - # - # ## Backdated cancellations - # - # Orb allows you to cancel a subscription in the past as long as there are no paid - # invoices between the `requested_date` and the current time. If the cancellation - # is after the latest issued invoice, Orb will generate a balance refund for the - # current period. If the cancellation is before the most recently issued invoice, - # Orb will void the intervening invoice and generate a new one based on the new - # dates for the subscription. See the section on - # [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors). + # serialized subscription object with an `end_date` parameter that signifies when + # the subscription will transition to an ended state. + # + # The body parameter `cancel_option` determines the cancellation behavior. Orb + # supports three cancellation options: + # + # - `end_of_subscription_term`: stops the subscription from auto-renewing. + # Subscriptions that have been cancelled with this option can still incur + # charges for the remainder of their term: + # + # - Issuing this cancellation request for a monthly subscription will keep the + # subscription active until the start of the subsequent month, and potentially + # issue an invoice for any usage charges incurred in the intervening period. + # - Issuing this cancellation request for a quarterly subscription will keep the + # subscription active until the end of the quarter and potentially issue an + # invoice for any usage charges incurred in the intervening period. + # - Issuing this cancellation request for a yearly subscription will keep the + # subscription active for the full year. For example, a yearly subscription + # starting on 2021-11-01 and cancelled on 2021-12-08 will remain active until + # 2022-11-01 and potentially issue charges in the intervening months for any + # recurring monthly usage charges in its plan. + # - **Note**: If a subscription's plan contains prices with difference cadences, + # the end of term date will be determined by the largest cadence value. For + # example, cancelling end of term for a subscription with a quarterly fixed + # fee with a monthly usage fee will result in the subscription ending at the + # end of the quarter. + # + # - `immediate`: ends the subscription immediately, setting the `end_date` to the + # current time: + # + # - Subscriptions that have been cancelled with this option will be invoiced + # immediately. This invoice will include any usage fees incurred in the + # billing period up to the cancellation, along with any prorated recurring + # fees for the billing period, if applicable. + # - **Note**: If the subscription has a recurring fee that was paid in-advance, + # the prorated amount for the remaining time period will be added to the + # [customer's balance](list-balance-transactions) upon immediate cancellation. + # However, if the customer is ineligible to use the customer balance, the + # subscription cannot be cancelled immediately. + # + # - `requested_date`: ends the subscription on a specified date, which requires a + # `cancellation_date` to be passed in. If no timezone is provided, the + # customer's timezone is used. For example, a subscription starting on January + # 1st with a monthly price can be set to be cancelled on the first of any month + # after January 1st (e.g. March 1st, April 1st, May 1st). A subscription with + # multiple prices with different cadences defines the "term" to be the highest + # cadence of the prices. + # + # Upcoming subscriptions are only eligible for immediate cancellation, which will + # set the `end_date` equal to the `start_date` upon cancellation. + # + # ## Backdated cancellations + # + # Orb allows you to cancel a subscription in the past as long as there are no paid + # invoices between the `requested_date` and the current time. If the cancellation + # is after the latest issued invoice, Orb will generate a balance refund for the + # current period. If the cancellation is before the most recently issued invoice, + # Orb will void the intervening invoice and generate a new one based on the new + # dates for the subscription. See the section on + # [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors). sig do params( subscription_id: String, @@ -541,16 +541,16 @@ module Orb # Determines the timing of subscription cancellation cancel_option:, # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. allow_invoice_credit_or_void: nil, # The date that the cancellation should take effect. This parameter can only be - # passed if the `cancel_option` is `requested_date`. + # passed if the `cancel_option` is `requested_date`. cancellation_date: nil, request_options: {} ); end # This endpoint is used to fetch a [Subscription](/core-concepts##subscription) - # given an identifier. + # given an identifier. sig do params( subscription_id: String, @@ -561,15 +561,15 @@ module Orb def fetch(subscription_id, request_options: {}); end # This endpoint is used to fetch a day-by-day snapshot of a subscription's costs - # in Orb, calculated by applying pricing information to the underlying usage (see - # the [subscription usage endpoint](fetch-subscription-usage) to fetch usage per - # metric, in usage units rather than a currency). - # - # The semantics of this endpoint exactly mirror those of - # [fetching a customer's costs](fetch-customer-costs). Use this endpoint to limit - # your analysis of costs to a specific subscription for the customer (e.g. to - # de-aggregate costs when a customer's subscription has started and stopped on the - # same day). + # in Orb, calculated by applying pricing information to the underlying usage (see + # the [subscription usage endpoint](fetch-subscription-usage) to fetch usage per + # metric, in usage units rather than a currency). + # + # The semantics of this endpoint exactly mirror those of + # [fetching a customer's costs](fetch-customer-costs). Use this endpoint to limit + # your analysis of costs to a specific subscription for the customer (e.g. to + # de-aggregate costs when a customer's subscription has started and stopped on the + # same day). sig do params( subscription_id: String, @@ -590,16 +590,16 @@ module Orb # Costs returned are inclusive of `timeframe_start`. timeframe_start: nil, # Controls whether Orb returns cumulative costs since the start of the billing - # period, or incremental day-by-day costs. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day costs. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. view_mode: nil, request_options: {} ); end # This endpoint returns a [paginated](/api-reference/pagination) list of all plans - # associated with a subscription along with their start and end dates. This list - # contains the subscription's initial plan along with past and future plan - # changes. + # associated with a subscription along with their start and end dates. This list + # contains the subscription's initial plan along with past and future plan + # changes. sig do params( subscription_id: String, @@ -616,7 +616,7 @@ module Orb def fetch_schedule( subscription_id, # Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # from the initial request. cursor: nil, # The number of items to fetch. Defaults to 20. limit: nil, @@ -627,199 +627,199 @@ module Orb request_options: {} ); end # This endpoint is used to fetch a subscription's usage in Orb. Especially when - # combined with optional query parameters, this endpoint is a powerful way to - # build visualizations on top of Orb's event data and metrics. - # - # With no query parameters specified, this endpoint returns usage for the - # subscription's _current billing period_ across each billable metric that - # participates in the subscription. Usage quantities returned are the result of - # evaluating the metric definition for the entirety of the customer's billing - # period. - # - # ### Default response shape - # - # Orb returns a `data` array with an object corresponding to each billable metric. - # Nested within this object is a `usage` array which has a `quantity` value and a - # corresponding `timeframe_start` and `timeframe_end`. The `quantity` value - # represents the calculated usage value for the billable metric over the specified - # timeframe (inclusive of the `timeframe_start` timestamp and exclusive of the - # `timeframe_end` timestamp). - # - # Orb will include _every_ window in the response starting from the beginning of - # the billing period, even when there were no events (and therefore no usage) in - # the window. This increases the size of the response but prevents the caller from - # filling in gaps and handling cumbersome time-based logic. - # - # The query parameters in this endpoint serve to override this behavior and - # provide some key functionality, as listed below. Note that this functionality - # can also be used _in conjunction_ with each other, e.g. to display grouped usage - # on a custom timeframe. - # - # ## Custom timeframe - # - # In order to view usage for a custom timeframe rather than the current billing - # period, specify a `timeframe_start` and `timeframe_end`. This will calculate - # quantities for usage incurred between timeframe_start (inclusive) and - # timeframe_end (exclusive), i.e. `[timeframe_start, timeframe_end)`. - # - # Note: - # - # - These timestamps must be specified in ISO 8601 format and UTC timezone, e.g. - # `2022-02-01T05:00:00Z`. - # - Both parameters must be specified if either is specified. - # - # ## Grouping by custom attributes - # - # In order to view a single metric grouped by a specific _attribute_ that each - # event is tagged with (e.g. `cluster`), you must additionally specify a - # `billable_metric_id` and a `group_by` key. The `group_by` key denotes the event - # property on which to group. - # - # When returning grouped usage, only usage for `billable_metric_id` is returned, - # and a separate object in the `data` array is returned for each value of the - # `group_by` key present in your events. The `quantity` value is the result of - # evaluating the billable metric for events filtered to a single value of the - # `group_by` key. - # - # Orb expects that events that match the billable metric will contain values in - # the `properties` dictionary that correspond to the `group_by` key specified. By - # default, Orb will not return a `null` group (i.e. events that match the metric - # but do not have the key set). Currently, it is only possible to view usage - # grouped by a single attribute at a time. - # - # When viewing grouped usage, Orb uses pagination to limit the response size to - # 1000 groups by default. If there are more groups for a given subscription, - # pagination metadata in the response can be used to fetch all of the data. - # - # The following example shows usage for an "API Requests" billable metric grouped - # by `region`. Note the extra `metric_group` dictionary in the response, which - # provides metadata about the group: - # - # ```json - # { - # "data": [ - # { - # "usage": [ - # { - # "quantity": 0.19291, - # "timeframe_start": "2021-10-01T07:00:00Z", - # "timeframe_end": "2021-10-02T07:00:00Z", - # }, - # ... - # ], - # "metric_group": { - # "property_key": "region", - # "property_value": "asia/pacific" - # }, - # "billable_metric": { - # "id": "Fe9pbpMk86xpwdGB", - # "name": "API Requests" - # }, - # "view_mode": "periodic" - # }, - # ... - # ] - # } - # ``` - # - # ## Windowed usage - # - # The `granularity` parameter can be used to _window_ the usage `quantity` value - # into periods. When not specified, usage is returned for the entirety of the time - # range. - # - # When `granularity = day` is specified with a timeframe longer than a day, Orb - # will return a `quantity` value for each full day between `timeframe_start` and - # `timeframe_end`. Note that the days are demarcated by the _customer's local - # midnight_. - # - # For example, with `timeframe_start = 2022-02-01T05:00:00Z`, - # `timeframe_end = 2022-02-04T01:00:00Z` and `granularity=day`, the following - # windows will be returned for a customer in the `America/Los_Angeles` timezone - # since local midnight is `08:00` UTC: - # - # - `[2022-02-01T05:00:00Z, 2022-02-01T08:00:00Z)` - # - `[2022-02-01T08:00:00, 2022-02-02T08:00:00Z)` - # - `[2022-02-02T08:00:00, 2022-02-03T08:00:00Z)` - # - `[2022-02-03T08:00:00, 2022-02-04T01:00:00Z)` - # - # ```json - # { - # "data": [ - # { - # "billable_metric": { - # "id": "Q8w89wjTtBdejXKsm", - # "name": "API Requests" - # }, - # "usage": [ - # { - # "quantity": 0, - # "timeframe_end": "2022-02-01T08:00:00+00:00", - # "timeframe_start": "2022-02-01T05:00:00+00:00" - # }, - # { - # - # "quantity": 0, - # "timeframe_end": "2022-02-02T08:00:00+00:00", - # "timeframe_start": "2022-02-01T08:00:00+00:00" - # }, - # { - # "quantity": 0, - # "timeframe_end": "2022-02-03T08:00:00+00:00", - # "timeframe_start": "2022-02-02T08:00:00+00:00" - # }, - # { - # "quantity": 0, - # "timeframe_end": "2022-02-04T01:00:00+00:00", - # "timeframe_start": "2022-02-03T08:00:00+00:00" - # } - # ], - # "view_mode": "periodic" - # }, - # ... - # ] - # } - # ``` - # - # ## Decomposable vs. non-decomposable metrics - # - # Billable metrics fall into one of two categories: decomposable and - # non-decomposable. A decomposable billable metric, such as a sum or a count, can - # be displayed and aggregated across arbitrary timescales. On the other hand, a - # non-decomposable metric is not meaningful when only a slice of the billing - # window is considered. - # - # As an example, if we have a billable metric that's defined to count unique - # users, displaying a graph of unique users for each day is not representative of - # the billable metric value over the month (days could have an overlapping set of - # 'unique' users). Instead, what's useful for any given day is the number of - # unique users in the billing period so far, which are the _cumulative_ unique - # users. - # - # Accordingly, this endpoint returns treats these two types of metrics differently - # when `group_by` is specified: - # - # - Decomposable metrics can be grouped by any event property. - # - Non-decomposable metrics can only be grouped by the corresponding price's - # invoice grouping key. If no invoice grouping key is present, the metric does - # not support `group_by`. - # - # ## Matrix prices - # - # When a billable metric is attached to a price that uses matrix pricing, it's - # important to view usage grouped by those matrix dimensions. In this case, use - # the query parameters `first_dimension_key`, `first_dimension_value` and - # `second_dimension_key`, `second_dimension_value` while filtering to a specific - # `billable_metric_id`. - # - # For example, if your compute metric has a separate unit price (i.e. a matrix - # pricing model) per `region` and `provider`, your request might provide the - # following parameters: - # - # - `first_dimension_key`: `region` - # - `first_dimension_value`: `us-east-1` - # - `second_dimension_key`: `provider` - # - `second_dimension_value`: `aws` + # combined with optional query parameters, this endpoint is a powerful way to + # build visualizations on top of Orb's event data and metrics. + # + # With no query parameters specified, this endpoint returns usage for the + # subscription's _current billing period_ across each billable metric that + # participates in the subscription. Usage quantities returned are the result of + # evaluating the metric definition for the entirety of the customer's billing + # period. + # + # ### Default response shape + # + # Orb returns a `data` array with an object corresponding to each billable metric. + # Nested within this object is a `usage` array which has a `quantity` value and a + # corresponding `timeframe_start` and `timeframe_end`. The `quantity` value + # represents the calculated usage value for the billable metric over the specified + # timeframe (inclusive of the `timeframe_start` timestamp and exclusive of the + # `timeframe_end` timestamp). + # + # Orb will include _every_ window in the response starting from the beginning of + # the billing period, even when there were no events (and therefore no usage) in + # the window. This increases the size of the response but prevents the caller from + # filling in gaps and handling cumbersome time-based logic. + # + # The query parameters in this endpoint serve to override this behavior and + # provide some key functionality, as listed below. Note that this functionality + # can also be used _in conjunction_ with each other, e.g. to display grouped usage + # on a custom timeframe. + # + # ## Custom timeframe + # + # In order to view usage for a custom timeframe rather than the current billing + # period, specify a `timeframe_start` and `timeframe_end`. This will calculate + # quantities for usage incurred between timeframe_start (inclusive) and + # timeframe_end (exclusive), i.e. `[timeframe_start, timeframe_end)`. + # + # Note: + # + # - These timestamps must be specified in ISO 8601 format and UTC timezone, e.g. + # `2022-02-01T05:00:00Z`. + # - Both parameters must be specified if either is specified. + # + # ## Grouping by custom attributes + # + # In order to view a single metric grouped by a specific _attribute_ that each + # event is tagged with (e.g. `cluster`), you must additionally specify a + # `billable_metric_id` and a `group_by` key. The `group_by` key denotes the event + # property on which to group. + # + # When returning grouped usage, only usage for `billable_metric_id` is returned, + # and a separate object in the `data` array is returned for each value of the + # `group_by` key present in your events. The `quantity` value is the result of + # evaluating the billable metric for events filtered to a single value of the + # `group_by` key. + # + # Orb expects that events that match the billable metric will contain values in + # the `properties` dictionary that correspond to the `group_by` key specified. By + # default, Orb will not return a `null` group (i.e. events that match the metric + # but do not have the key set). Currently, it is only possible to view usage + # grouped by a single attribute at a time. + # + # When viewing grouped usage, Orb uses pagination to limit the response size to + # 1000 groups by default. If there are more groups for a given subscription, + # pagination metadata in the response can be used to fetch all of the data. + # + # The following example shows usage for an "API Requests" billable metric grouped + # by `region`. Note the extra `metric_group` dictionary in the response, which + # provides metadata about the group: + # + # ```json + # { + # "data": [ + # { + # "usage": [ + # { + # "quantity": 0.19291, + # "timeframe_start": "2021-10-01T07:00:00Z", + # "timeframe_end": "2021-10-02T07:00:00Z", + # }, + # ... + # ], + # "metric_group": { + # "property_key": "region", + # "property_value": "asia/pacific" + # }, + # "billable_metric": { + # "id": "Fe9pbpMk86xpwdGB", + # "name": "API Requests" + # }, + # "view_mode": "periodic" + # }, + # ... + # ] + # } + # ``` + # + # ## Windowed usage + # + # The `granularity` parameter can be used to _window_ the usage `quantity` value + # into periods. When not specified, usage is returned for the entirety of the time + # range. + # + # When `granularity = day` is specified with a timeframe longer than a day, Orb + # will return a `quantity` value for each full day between `timeframe_start` and + # `timeframe_end`. Note that the days are demarcated by the _customer's local + # midnight_. + # + # For example, with `timeframe_start = 2022-02-01T05:00:00Z`, + # `timeframe_end = 2022-02-04T01:00:00Z` and `granularity=day`, the following + # windows will be returned for a customer in the `America/Los_Angeles` timezone + # since local midnight is `08:00` UTC: + # + # - `[2022-02-01T05:00:00Z, 2022-02-01T08:00:00Z)` + # - `[2022-02-01T08:00:00, 2022-02-02T08:00:00Z)` + # - `[2022-02-02T08:00:00, 2022-02-03T08:00:00Z)` + # - `[2022-02-03T08:00:00, 2022-02-04T01:00:00Z)` + # + # ```json + # { + # "data": [ + # { + # "billable_metric": { + # "id": "Q8w89wjTtBdejXKsm", + # "name": "API Requests" + # }, + # "usage": [ + # { + # "quantity": 0, + # "timeframe_end": "2022-02-01T08:00:00+00:00", + # "timeframe_start": "2022-02-01T05:00:00+00:00" + # }, + # { + # + # "quantity": 0, + # "timeframe_end": "2022-02-02T08:00:00+00:00", + # "timeframe_start": "2022-02-01T08:00:00+00:00" + # }, + # { + # "quantity": 0, + # "timeframe_end": "2022-02-03T08:00:00+00:00", + # "timeframe_start": "2022-02-02T08:00:00+00:00" + # }, + # { + # "quantity": 0, + # "timeframe_end": "2022-02-04T01:00:00+00:00", + # "timeframe_start": "2022-02-03T08:00:00+00:00" + # } + # ], + # "view_mode": "periodic" + # }, + # ... + # ] + # } + # ``` + # + # ## Decomposable vs. non-decomposable metrics + # + # Billable metrics fall into one of two categories: decomposable and + # non-decomposable. A decomposable billable metric, such as a sum or a count, can + # be displayed and aggregated across arbitrary timescales. On the other hand, a + # non-decomposable metric is not meaningful when only a slice of the billing + # window is considered. + # + # As an example, if we have a billable metric that's defined to count unique + # users, displaying a graph of unique users for each day is not representative of + # the billable metric value over the month (days could have an overlapping set of + # 'unique' users). Instead, what's useful for any given day is the number of + # unique users in the billing period so far, which are the _cumulative_ unique + # users. + # + # Accordingly, this endpoint returns treats these two types of metrics differently + # when `group_by` is specified: + # + # - Decomposable metrics can be grouped by any event property. + # - Non-decomposable metrics can only be grouped by the corresponding price's + # invoice grouping key. If no invoice grouping key is present, the metric does + # not support `group_by`. + # + # ## Matrix prices + # + # When a billable metric is attached to a price that uses matrix pricing, it's + # important to view usage grouped by those matrix dimensions. In this case, use + # the query parameters `first_dimension_key`, `first_dimension_value` and + # `second_dimension_key`, `second_dimension_value` while filtering to a specific + # `billable_metric_id`. + # + # For example, if your compute metric has a separate unit price (i.e. a matrix + # pricing model) per `region` and `provider`, your request might provide the + # following parameters: + # + # - `first_dimension_key`: `region` + # - `first_dimension_value`: `us-east-1` + # - `second_dimension_key`: `provider` + # - `second_dimension_value`: `aws` sig do params( subscription_id: String, @@ -845,8 +845,8 @@ module Orb def fetch_usage( subscription_id, # When specified in conjunction with `group_by`, this parameter filters usage to a - # single billable metric. Note that both `group_by` and `billable_metric_id` must - # be specified together. + # single billable metric. Note that both `group_by` and `billable_metric_id` must + # be specified together. billable_metric_id: nil, first_dimension_key: nil, first_dimension_value: nil, @@ -861,84 +861,84 @@ module Orb # Usage returned is inclusive of `timeframe_start`. timeframe_start: nil, # Controls whether Orb returns cumulative usage since the start of the billing - # period, or incremental day-by-day usage. If your customer has minimums or - # discounts, it's strongly recommended that you use the default cumulative - # behavior. + # period, or incremental day-by-day usage. If your customer has minimums or + # discounts, it's strongly recommended that you use the default cumulative + # behavior. view_mode: nil, request_options: {} ); end # This endpoint is used to add and edit subscription - # [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By - # making modifications to a subscription’s price intervals, you can - # [flexibly and atomically control the billing behavior of a subscription](/product-catalog/modifying-subscriptions). - # - # ## Adding price intervals - # - # Prices can be added as price intervals to a subscription by specifying them in - # the `add` array. A `price_id` or `external_price_id` from an add-on price or - # previously removed plan price can be specified to reuse an existing price - # definition (however, please note that prices from other plans cannot be added to - # the subscription). Additionally, a new price can be specified using the `price` - # field — this price will be created automatically. - # - # A `start_date` must be specified for the price interval. This is the date when - # the price will start billing on the subscription, so this will notably result in - # an immediate charge at this time for any billed in advance fixed fees. The - # `end_date` will default to null, resulting in a price interval that will bill on - # a continually recurring basis. Both of these dates can be set in the past or the - # future and Orb will generate or modify invoices to ensure the subscription’s - # invoicing behavior is correct. - # - # Additionally, a discount, minimum, or maximum can be specified on the price - # interval. This will only apply to this price interval, not any other price - # intervals on the subscription. - # - # ## Adjustment intervals - # - # An adjustment interval represents the time period that a particular adjustment - # (a discount, minimum, or maximum) applies to the prices on a subscription. - # Adjustment intervals can be added to a subscription by specifying them in the - # `add_adjustments` array, or modified via the `edit_adjustments` array. When - # creating an adjustment interval, you'll need to provide the definition of the - # new adjustment (the type of adjustment, and which prices it applies to), as well - # as the start and end dates for the adjustment interval. The start and end dates - # of an existing adjustment interval can be edited via the `edit_adjustments` - # field (just like price intervals). (To "change" the amount of a discount, - # minimum, or maximum, then, you'll need to end the existing interval, and create - # a new adjustment interval with the new amount and a start date that matches the - # end date of the previous interval.) - # - # ## Editing price intervals - # - # Price intervals can be adjusted by specifying edits to make in the `edit` array. - # A `price_interval_id` to edit must be specified — this can be retrieved from the - # `price_intervals` field on the subscription. - # - # A new `start_date` or `end_date` can be specified to change the range of the - # price interval, which will modify past or future invoices to ensure correctness. - # If either of these dates are unspecified, they will default to the existing date - # on the price interval. To remove a price interval entirely from a subscription, - # set the `end_date` to be equivalent to the `start_date`. - # - # ## Fixed fee quantity transitions - # - # The fixed fee quantity transitions for a fixed fee price interval can also be - # specified when adding or editing by passing an array for - # `fixed_fee_quantity_transitions`. A fixed fee quantity transition must have a - # `quantity` and an `effective_date`, which is the date after which the new - # quantity will be used for billing. If a fixed fee quantity transition is - # scheduled at a billing period boundary, the full quantity will be billed on an - # invoice with the other prices on the subscription. If the fixed fee quantity - # transition is scheduled mid-billing period, the difference between the existing - # quantity and quantity specified in the transition will be prorated for the rest - # of the billing period and billed immediately, which will generate a new invoice. - # - # Notably, the list of fixed fee quantity transitions passed will overwrite the - # existing fixed fee quantity transitions on the price interval, so the entire - # list of transitions must be specified to add additional transitions. The - # existing list of transitions can be retrieved using the - # `fixed_fee_quantity_transitions` property on a subscription’s serialized price - # intervals. + # [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By + # making modifications to a subscription’s price intervals, you can + # [flexibly and atomically control the billing behavior of a subscription](/product-catalog/modifying-subscriptions). + # + # ## Adding price intervals + # + # Prices can be added as price intervals to a subscription by specifying them in + # the `add` array. A `price_id` or `external_price_id` from an add-on price or + # previously removed plan price can be specified to reuse an existing price + # definition (however, please note that prices from other plans cannot be added to + # the subscription). Additionally, a new price can be specified using the `price` + # field — this price will be created automatically. + # + # A `start_date` must be specified for the price interval. This is the date when + # the price will start billing on the subscription, so this will notably result in + # an immediate charge at this time for any billed in advance fixed fees. The + # `end_date` will default to null, resulting in a price interval that will bill on + # a continually recurring basis. Both of these dates can be set in the past or the + # future and Orb will generate or modify invoices to ensure the subscription’s + # invoicing behavior is correct. + # + # Additionally, a discount, minimum, or maximum can be specified on the price + # interval. This will only apply to this price interval, not any other price + # intervals on the subscription. + # + # ## Adjustment intervals + # + # An adjustment interval represents the time period that a particular adjustment + # (a discount, minimum, or maximum) applies to the prices on a subscription. + # Adjustment intervals can be added to a subscription by specifying them in the + # `add_adjustments` array, or modified via the `edit_adjustments` array. When + # creating an adjustment interval, you'll need to provide the definition of the + # new adjustment (the type of adjustment, and which prices it applies to), as well + # as the start and end dates for the adjustment interval. The start and end dates + # of an existing adjustment interval can be edited via the `edit_adjustments` + # field (just like price intervals). (To "change" the amount of a discount, + # minimum, or maximum, then, you'll need to end the existing interval, and create + # a new adjustment interval with the new amount and a start date that matches the + # end date of the previous interval.) + # + # ## Editing price intervals + # + # Price intervals can be adjusted by specifying edits to make in the `edit` array. + # A `price_interval_id` to edit must be specified — this can be retrieved from the + # `price_intervals` field on the subscription. + # + # A new `start_date` or `end_date` can be specified to change the range of the + # price interval, which will modify past or future invoices to ensure correctness. + # If either of these dates are unspecified, they will default to the existing date + # on the price interval. To remove a price interval entirely from a subscription, + # set the `end_date` to be equivalent to the `start_date`. + # + # ## Fixed fee quantity transitions + # + # The fixed fee quantity transitions for a fixed fee price interval can also be + # specified when adding or editing by passing an array for + # `fixed_fee_quantity_transitions`. A fixed fee quantity transition must have a + # `quantity` and an `effective_date`, which is the date after which the new + # quantity will be used for billing. If a fixed fee quantity transition is + # scheduled at a billing period boundary, the full quantity will be billed on an + # invoice with the other prices on the subscription. If the fixed fee quantity + # transition is scheduled mid-billing period, the difference between the existing + # quantity and quantity specified in the transition will be prorated for the rest + # of the billing period and billed immediately, which will generate a new invoice. + # + # Notably, the list of fixed fee quantity transitions passed will overwrite the + # existing fixed fee quantity transitions on the price interval, so the entire + # list of transitions must be specified to add additional transitions. The + # existing list of transitions can be retrieved using the + # `fixed_fee_quantity_transitions` property on a subscription’s serialized price + # intervals. sig do params( subscription_id: String, @@ -958,8 +958,8 @@ module Orb # A list of adjustments to add to the subscription. add_adjustments: nil, # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. allow_invoice_credit_or_void: nil, # A list of price intervals to edit on the subscription. edit: nil, @@ -968,188 +968,188 @@ module Orb request_options: {} ); end # This endpoint can be used to change an existing subscription's plan. It returns - # the serialized updated subscription object. - # - # The body parameter `change_option` determines when the plan change occurrs. Orb - # supports three options: - # - # - `end_of_subscription_term`: changes the plan at the end of the existing plan's - # term. - # - Issuing this plan change request for a monthly subscription will keep the - # existing plan active until the start of the subsequent month. Issuing this - # plan change request for a yearly subscription will keep the existing plan - # active for the full year. Charges incurred in the remaining period will be - # invoiced as normal. - # - Example: The plan is billed monthly on the 1st of the month, the request is - # made on January 15th, so the plan will be changed on February 1st, and - # invoice will be issued on February 1st for the last month of the original - # plan. - # - `immediate`: changes the plan immediately. - # - Subscriptions that have their plan changed with this option will move to the - # new plan immediately, and be invoiced immediately. - # - This invoice will include any usage fees incurred in the billing period up - # to the change, along with any prorated recurring fees for the billing - # period, if applicable. - # - Example: The plan is billed monthly on the 1st of the month, the request is - # made on January 15th, so the plan will be changed on January 15th, and an - # invoice will be issued for the partial month, from January 1 to January 15, - # on the original plan. - # - `requested_date`: changes the plan on the requested date (`change_date`). - # - If no timezone is provided, the customer's timezone is used. The - # `change_date` body parameter is required if this option is chosen. - # - Example: The plan is billed monthly on the 1st of the month, the request is - # made on January 15th, with a requested `change_date` of February 15th, so - # the plan will be changed on February 15th, and invoices will be issued on - # February 1st and February 15th. - # - # Note that one of `plan_id` or `external_plan_id` is required in the request body - # for this operation. - # - # ## Customize your customer's subscriptions - # - # Prices and adjustments in a plan can be added, removed, or replaced on the - # subscription when you schedule the plan change. This is useful when a customer - # has prices that differ from the default prices for a specific plan. - # - # - # This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your - # Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans) - # - # - # ### Adding Prices - # - # To add prices, provide a list of objects with the key `add_prices`. An object in - # the list must specify an existing add-on price with a `price_id` or - # `external_price_id` field, or create a new add-on price by including an object - # with the key `price`, identical to what would be used in the request body for - # the [create price endpoint](/api-reference/price/create-price). See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations possible in this object. - # - # If the plan has phases, each object in the list must include a number with - # `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`. 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 - # to this price. - # - # Additionally, an object in the list can specify an optional `reference_id`. This - # ID can be used to reference this price when - # [adding an adjustment](#adding-adjustments) in the same API call. However the ID - # is _transient_ and cannot be used to refer to the price in future API calls. - # - # ### Removing Prices - # - # To remove prices, provide a list of objects with the key `remove_prices`. An - # object in the list must specify a plan price with either a `price_id` or - # `external_price_id` field. - # - # ### Replacing Prices - # - # To replace prices, provide a list of objects with the key `replace_prices`. An - # object in the list must specify a plan price to replace with the - # `replaces_price_id` key, and it must specify a price to replace it with by - # either referencing an existing add-on price with a `price_id` or - # `external_price_id` field, or by creating a new add-on price by including an - # object with the key `price`, identical to what would be used in the request body - # for the [create price endpoint](/api-reference/price/create-price). See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations possible in this object. - # - # For fixed fees, an object in the list can supply a `fixed_price_quantity` - # instead of a `price`, `price_id`, or `external_price_id` field. This will update - # only the quantity for the price, similar to the - # [Update price quantity](/api-reference/subscription/update-price-quantity) - # endpoint. - # - # The replacement price will have the same phase, if applicable, and the same - # start and end dates as the price it replaces. - # - # An object in the list can specify an optional `minimum_amount`, - # `maximum_amount`, or `discounts`. This will create adjustments which apply only - # to this price. - # - # Additionally, an object in the list can specify an optional `reference_id`. This - # ID can be used to reference the replacement price when - # [adding an adjustment](#adding-adjustments) in the same API call. However the ID - # is _transient_ and cannot be used to refer to the price in future API calls. - # - # ### Adding adjustments - # - # To add adjustments, provide a list of objects with the key `add_adjustments`. An - # object in the list must include an object with the key `adjustment`, identical - # to the adjustment object in the - # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - # - # If the plan has phases, each object in the list must include a number with - # `plan_phase_order` key to indicate which phase the adjustment should be added - # to. - # - # An object in the list can specify an optional `start_date` and optional - # `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 - # - # To remove adjustments, provide a list of objects with the key - # `remove_adjustments`. An object in the list must include a key, `adjustment_id`, - # with the ID of the adjustment to be removed. + # the serialized updated subscription object. + # + # The body parameter `change_option` determines when the plan change occurrs. Orb + # supports three options: + # + # - `end_of_subscription_term`: changes the plan at the end of the existing plan's + # term. + # - Issuing this plan change request for a monthly subscription will keep the + # existing plan active until the start of the subsequent month. Issuing this + # plan change request for a yearly subscription will keep the existing plan + # active for the full year. Charges incurred in the remaining period will be + # invoiced as normal. + # - Example: The plan is billed monthly on the 1st of the month, the request is + # made on January 15th, so the plan will be changed on February 1st, and + # invoice will be issued on February 1st for the last month of the original + # plan. + # - `immediate`: changes the plan immediately. + # - Subscriptions that have their plan changed with this option will move to the + # new plan immediately, and be invoiced immediately. + # - This invoice will include any usage fees incurred in the billing period up + # to the change, along with any prorated recurring fees for the billing + # period, if applicable. + # - Example: The plan is billed monthly on the 1st of the month, the request is + # made on January 15th, so the plan will be changed on January 15th, and an + # invoice will be issued for the partial month, from January 1 to January 15, + # on the original plan. + # - `requested_date`: changes the plan on the requested date (`change_date`). + # - If no timezone is provided, the customer's timezone is used. The + # `change_date` body parameter is required if this option is chosen. + # - Example: The plan is billed monthly on the 1st of the month, the request is + # made on January 15th, with a requested `change_date` of February 15th, so + # the plan will be changed on February 15th, and invoices will be issued on + # February 1st and February 15th. + # + # Note that one of `plan_id` or `external_plan_id` is required in the request body + # for this operation. + # + # ## Customize your customer's subscriptions + # + # Prices and adjustments in a plan can be added, removed, or replaced on the + # subscription when you schedule the plan change. This is useful when a customer + # has prices that differ from the default prices for a specific plan. + # + # + # This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your + # Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans) + # + # + # ### Adding Prices + # + # To add prices, provide a list of objects with the key `add_prices`. An object in + # the list must specify an existing add-on price with a `price_id` or + # `external_price_id` field, or create a new add-on price by including an object + # with the key `price`, identical to what would be used in the request body for + # the [create price endpoint](/api-reference/price/create-price). See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations possible in this object. + # + # If the plan has phases, each object in the list must include a number with + # `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`. 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 + # to this price. + # + # Additionally, an object in the list can specify an optional `reference_id`. This + # ID can be used to reference this price when + # [adding an adjustment](#adding-adjustments) in the same API call. However the ID + # is _transient_ and cannot be used to refer to the price in future API calls. + # + # ### Removing Prices + # + # To remove prices, provide a list of objects with the key `remove_prices`. An + # object in the list must specify a plan price with either a `price_id` or + # `external_price_id` field. + # + # ### Replacing Prices + # + # To replace prices, provide a list of objects with the key `replace_prices`. An + # object in the list must specify a plan price to replace with the + # `replaces_price_id` key, and it must specify a price to replace it with by + # either referencing an existing add-on price with a `price_id` or + # `external_price_id` field, or by creating a new add-on price by including an + # object with the key `price`, identical to what would be used in the request body + # for the [create price endpoint](/api-reference/price/create-price). See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations possible in this object. + # + # For fixed fees, an object in the list can supply a `fixed_price_quantity` + # instead of a `price`, `price_id`, or `external_price_id` field. This will update + # only the quantity for the price, similar to the + # [Update price quantity](/api-reference/subscription/update-price-quantity) + # endpoint. + # + # The replacement price will have the same phase, if applicable, and the same + # start and end dates as the price it replaces. + # + # An object in the list can specify an optional `minimum_amount`, + # `maximum_amount`, or `discounts`. This will create adjustments which apply only + # to this price. + # + # Additionally, an object in the list can specify an optional `reference_id`. This + # ID can be used to reference the replacement price when + # [adding an adjustment](#adding-adjustments) in the same API call. However the ID + # is _transient_ and cannot be used to refer to the price in future API calls. + # + # ### Adding adjustments + # + # To add adjustments, provide a list of objects with the key `add_adjustments`. An + # object in the list must include an object with the key `adjustment`, identical + # to the adjustment object in the + # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). + # + # If the plan has phases, each object in the list must include a number with + # `plan_phase_order` key to indicate which phase the adjustment should be added + # to. + # + # An object in the list can specify an optional `start_date` and optional + # `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 + # + # To remove adjustments, provide a list of objects with the key + # `remove_adjustments`. An object in the list must include a key, `adjustment_id`, + # with the ID of the adjustment to be removed. # - # ### Replacing adjustments - # - # To replace adjustments, provide a list of objects with the key - # `replace_adjustments`. An object in the list must specify a plan adjustment to - # replace with the `replaces_adjustment_id` key, and it must specify an adjustment - # to replace it with by including an object with the key `adjustment`, identical - # to the adjustment object in the - # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). - # - # The replacement adjustment will have the same phase, if applicable, and the same - # start and end dates as the adjustment it replaces. - # - # ## Price overrides (DEPRECATED) - # - # - # Price overrides are being phased out in favor adding/removing/replacing prices. (See - # [Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change)) - # - # - # Price overrides are used to update some or all prices in a plan for the specific - # subscription being created. This is useful when a new customer has negotiated a - # rate that is unique to the customer. + # ### Replacing adjustments + # + # To replace adjustments, provide a list of objects with the key + # `replace_adjustments`. An object in the list must specify a plan adjustment to + # replace with the `replaces_adjustment_id` key, and it must specify an adjustment + # to replace it with by including an object with the key `adjustment`, identical + # to the adjustment object in the + # [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals). + # + # The replacement adjustment will have the same phase, if applicable, and the same + # start and end dates as the adjustment it replaces. + # + # ## Price overrides (DEPRECATED) + # + # + # Price overrides are being phased out in favor adding/removing/replacing prices. (See + # [Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change)) + # + # + # Price overrides are used to update some or all prices in a plan for the specific + # subscription being created. This is useful when a new customer has negotiated a + # rate that is unique to the customer. # - # To override prices, provide a list of objects with the key `price_overrides`. - # The price object in the list of overrides is expected to contain the existing - # price id, the `model_type` and configuration. (See the - # [Price resource](/product-catalog/price-configuration) for the specification of - # different price model configurations.) The numerical values can be updated, but - # the billable metric, cadence, type, and name of a price can not be overridden. - # - # ### Maximums, and minimums + # To override prices, provide a list of objects with the key `price_overrides`. + # The price object in the list of overrides is expected to contain the existing + # price id, the `model_type` and configuration. (See the + # [Price resource](/product-catalog/price-configuration) for the specification of + # different price model configurations.) The numerical values can be updated, but + # the billable metric, cadence, type, and name of a price can not be overridden. + # + # ### Maximums, and minimums # - # Price overrides are used to update some or all prices in the target plan. - # Minimums and maximums, much like price overrides, can be useful when a new - # customer has negotiated a new or different minimum or maximum spend cap than the - # default for the plan. The request format for maximums and minimums is the same - # as those in [subscription creation](create-subscription). - # - # ## Scheduling multiple plan changes + # Price overrides are used to update some or all prices in the target plan. + # Minimums and maximums, much like price overrides, can be useful when a new + # customer has negotiated a new or different minimum or maximum spend cap than the + # default for the plan. The request format for maximums and minimums is the same + # as those in [subscription creation](create-subscription). + # + # ## Scheduling multiple plan changes # - # When scheduling multiple plan changes with the same date, the latest plan change - # on that day takes effect. + # When scheduling multiple plan changes with the same date, the latest plan change + # on that day takes effect. # - # ## Prorations for in-advance fees - # - # By default, Orb calculates the prorated difference in any fixed fees when making - # a plan change, adjusting the customer balance as needed. For details on this - # behavior, see - # [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees). + # ## Prorations for in-advance fees + # + # By default, Orb calculates the prorated difference in any fixed fees when making + # a plan change, adjusting the customer balance as needed. For details on this + # behavior, see + # [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees). sig do params( subscription_id: String, @@ -1204,90 +1204,90 @@ module Orb subscription_id, change_option:, # Additional adjustments to be added to the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) add_adjustments: nil, # Additional prices to be added to the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) add_prices: nil, # [DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be - # aligned with the plan change's effective date. + # aligned with the plan change's effective date. align_billing_with_plan_change_date: nil, # Determines whether issued invoices for this subscription will automatically be - # charged with the saved payment method on the due date. If not specified, this - # defaults to the behavior configured for this customer. + # charged with the saved payment method on the due date. If not specified, this + # defaults to the behavior configured for this customer. auto_collection: nil, # Reset billing periods to be aligned with the plan change's effective date or - # start of the month. Defaults to `unchanged` which keeps subscription's existing - # billing cycle alignment. + # start of the month. Defaults to `unchanged` which keeps subscription's existing + # billing cycle alignment. billing_cycle_alignment: nil, billing_cycle_anchor_configuration: nil, # The date that the plan change should take effect. This parameter can only be - # passed if the `change_option` is `requested_date`. If a date with no time is - # passed, the plan change will happen at midnight in the customer's timezone. + # passed if the `change_option` is `requested_date`. If a date with no time is + # passed, the plan change will happen at midnight in the customer's timezone. change_date: nil, # Redemption code to be used for this subscription. If the coupon cannot be found - # by its redemption code, or cannot be redeemed, an error response will be - # returned and the subscription creation or plan change will not be scheduled. + # by its redemption code, or cannot be redeemed, an error response will be + # returned and the subscription creation or plan change will not be scheduled. coupon_redemption_code: nil, credits_overage_rate: nil, # Determines the default memo on this subscription's invoices. Note that if this - # is not provided, it is determined by the plan configuration. + # is not provided, it is determined by the plan configuration. default_invoice_memo: nil, # The external_plan_id of the plan that the given subscription should be switched - # to. Note that either this property or `plan_id` must be specified. + # to. Note that either this property or `plan_id` must be specified. external_plan_id: nil, # An additional filter to apply to usage queries. This filter must be expressed as - # a boolean - # [computed property](/extensibility/advanced-metrics#computed-properties). If - # null, usage queries will not include any additional filter. + # a boolean + # [computed property](/extensibility/advanced-metrics#computed-properties). If + # null, usage queries will not include any additional filter. filter: nil, # The phase of the plan to start with initial_phase_order: nil, # When this subscription's accrued usage reaches this threshold, an invoice will - # be issued for the subscription. If not specified, invoices will only be issued - # at the end of the billing period. + # be issued for the subscription. If not specified, invoices will only be issued + # at the end of the billing period. invoicing_threshold: nil, # The net terms determines the difference between the invoice date and the issue - # date for the invoice. If you intend the invoice to be due on issue, set this - # to 0. If not provided, this defaults to the value specified in the plan. + # date for the invoice. If you intend the invoice to be due on issue, set this + # to 0. If not provided, this defaults to the value specified in the plan. net_terms: nil, per_credit_overage_amount: nil, # The plan that the given subscription should be switched to. Note that either - # this property or `external_plan_id` must be specified. + # this property or `external_plan_id` must be specified. plan_id: nil, # Specifies which version of the plan to change to. If null, the default version - # will be used. + # will be used. plan_version_number: nil, # Optionally provide a list of overrides for prices on the plan price_overrides: nil, # Plan adjustments to be removed from the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) + # accounts that have migrated off of legacy subscription overrides) remove_adjustments: nil, # Plan prices to be removed from the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) + # that have migrated off of legacy subscription overrides) remove_prices: nil, # Plan adjustments to be replaced with additional adjustments on the subscription. - # (Only available for accounts that have migrated off of legacy subscription - # overrides) + # (Only available for accounts that have migrated off of legacy subscription + # overrides) replace_adjustments: nil, # Plan prices to be replaced with additional prices on the subscription. (Only - # available for accounts that have migrated off of legacy subscription overrides) + # available for accounts that have migrated off of legacy subscription overrides) replace_prices: nil, # The duration of the trial period in days. If not provided, this defaults to the - # value specified in the plan. If `0` is provided, the trial on the plan will be - # skipped. + # value specified in the plan. If `0` is provided, the trial on the plan will be + # skipped. trial_duration_days: nil, # A list of customer IDs whose usage events will be aggregated and billed under - # this subscription. By default, a subscription only considers usage events - # associated with its attached customer's customer_id. When usage_customer_ids is - # provided, the subscription includes usage events from the specified customers - # only. Provided usage_customer_ids must be either the customer for this - # subscription itself, or any of that customer's children. + # this subscription. By default, a subscription only considers usage events + # associated with its attached customer's customer_id. When usage_customer_ids is + # provided, the subscription includes usage events from the specified customers + # only. Provided usage_customer_ids must be either the customer for this + # subscription itself, or any of that customer's children. usage_customer_ids: nil, request_options: {} ); end # Manually trigger a phase, effective the given date (or the current time, if not - # specified). + # specified). sig do params( subscription_id: String, @@ -1300,20 +1300,20 @@ module Orb def trigger_phase( subscription_id, # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. allow_invoice_credit_or_void: nil, # The date on which the phase change should take effect. If not provided, defaults - # to today in the customer's timezone. + # to today in the customer's timezone. effective_date: nil, request_options: {} ); end # This endpoint can be used to unschedule any pending cancellations for a - # subscription. + # subscription. # - # To be eligible, the subscription must currently be active and have a future - # cancellation. This operation will turn on auto-renew, ensuring that the - # subscription does not end at the currently scheduled cancellation time. + # To be eligible, the subscription must currently be active and have a future + # cancellation. This operation will turn on auto-renew, ensuring that the + # subscription does not end at the currently scheduled cancellation time. sig do params( subscription_id: String, @@ -1324,10 +1324,10 @@ module Orb def unschedule_cancellation(subscription_id, request_options: {}); end # This endpoint can be used to clear scheduled updates to the quantity for a fixed - # fee. + # fee. # - # If there are no updates scheduled, a request validation error will be returned - # with a 400 status code. + # If there are no updates scheduled, a request validation error will be returned + # with a 400 status code. sig do params( subscription_id: String, @@ -1343,7 +1343,7 @@ module Orb request_options: {} ); end # This endpoint can be used to unschedule any pending plan changes on an existing - # subscription. + # subscription. sig do params( subscription_id: String, @@ -1355,18 +1355,18 @@ module Orb # This endpoint can be used to update the quantity for a fixed fee. # - # To be eligible, the subscription must currently be active and the price - # specified must be a fixed fee (not usage-based). This operation will immediately - # update the quantity for the fee, or if a `effective_date` is passed in, will - # update the quantity on the requested date at midnight in the customer's - # timezone. + # To be eligible, the subscription must currently be active and the price + # specified must be a fixed fee (not usage-based). This operation will immediately + # update the quantity for the fee, or if a `effective_date` is passed in, will + # update the quantity on the requested date at midnight in the customer's + # timezone. # - # In order to change the fixed fee quantity as of the next draft invoice for this - # subscription, pass `change_option=upcoming_invoice` without an `effective_date` - # specified. + # In order to change the fixed fee quantity as of the next draft invoice for this + # subscription, pass `change_option=upcoming_invoice` without an `effective_date` + # specified. # - # If the fee is an in-advance fixed fee, it will also issue an immediate invoice - # for the difference for the remainder of the billing period. + # If the fee is an in-advance fixed fee, it will also issue an immediate invoice + # for the difference for the remainder of the billing period. sig do params( subscription_id: String, @@ -1385,37 +1385,37 @@ module Orb price_id:, quantity:, # If false, this request will fail if it would void an issued invoice or create a - # credit note. Consider using this as a safety mechanism if you do not expect - # existing invoices to be changed. + # credit note. Consider using this as a safety mechanism if you do not expect + # existing invoices to be changed. allow_invoice_credit_or_void: nil, # Determines when the change takes effect. Note that if `effective_date` is - # specified, this defaults to `effective_date`. Otherwise, this defaults to - # `immediate` unless it's explicitly set to `upcoming_invoice`. + # specified, this defaults to `effective_date`. Otherwise, this defaults to + # `immediate` unless it's explicitly set to `upcoming_invoice`. change_option: nil, # The date that the quantity change should take effect, localized to the - # customer's timezone. Ifthis parameter is not passed in, the quantity change is - # effective according to `change_option`. + # customer's timezone. Ifthis parameter is not passed in, the quantity change is + # effective according to `change_option`. effective_date: nil, request_options: {} ); end # This endpoint is used to update the trial end date for a subscription. The new - # trial end date must be within the time range of the current plan (i.e. the new - # trial end date must be on or after the subscription's start date on the current - # plan, and on or before the subscription end date). - # - # In order to retroactively remove a trial completely, the end date can be set to - # the transition date of the subscription to this plan (or, if this is the first - # plan for this subscription, the subscription's start date). In order to end a - # trial immediately, the keyword `immediate` can be provided as the trial end - # date. - # - # By default, Orb will shift only the trial end date (and price intervals that - # start or end on the previous trial end date), and leave all other future price - # intervals untouched. If the `shift` parameter is set to `true`, Orb will shift - # all subsequent price and adjustment intervals by the same amount as the trial - # end date shift (so, e.g., if a plan change is scheduled or an add-on price was - # added, that change will be pushed back by the same amount of time the trial is - # extended). + # trial end date must be within the time range of the current plan (i.e. the new + # trial end date must be on or after the subscription's start date on the current + # plan, and on or before the subscription end date). + # + # In order to retroactively remove a trial completely, the end date can be set to + # the transition date of the subscription to this plan (or, if this is the first + # plan for this subscription, the subscription's start date). In order to end a + # trial immediately, the keyword `immediate` can be provided as the trial end + # date. + # + # By default, Orb will shift only the trial end date (and price intervals that + # start or end on the previous trial end date), and leave all other future price + # intervals untouched. If the `shift` parameter is set to `true`, Orb will shift + # all subsequent price and adjustment intervals by the same amount as the trial + # end date shift (so, e.g., if a plan change is scheduled or an add-on price was + # added, that change will be pushed back by the same amount of time the trial is + # extended). sig do params( subscription_id: String, @@ -1428,10 +1428,10 @@ module Orb def update_trial( subscription_id, # The new date that the trial should end, or the literal string `immediate` to end - # the trial immediately. + # the trial immediately. trial_end_date:, # If true, shifts subsequent price and adjustment intervals (preserving their - # durations, but adjusting their absolute dates). + # durations, but adjusting their absolute dates). shift: nil, request_options: {} ); end diff --git a/rbi/lib/orb/resources/top_level.rbi b/rbi/lib/orb/resources/top_level.rbi index c644cab6..7da93b8f 100644 --- a/rbi/lib/orb/resources/top_level.rbi +++ b/rbi/lib/orb/resources/top_level.rbi @@ -4,11 +4,11 @@ module Orb module Resources class TopLevel # This endpoint allows you to test your connection to the Orb API and check the - # validity of your API key, passed in the Authorization header. This is - # particularly useful for checking that your environment is set up properly, and - # is a great choice for connectors and integrations. + # validity of your API key, passed in the Authorization header. This is + # particularly useful for checking that your environment is set up properly, and + # is a great choice for connectors and integrations. # - # This API does not have any side-effects or return any Orb resources. + # This API does not have any side-effects or return any Orb resources. sig do params(request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))) .returns(Orb::Models::TopLevelPingResponse) From ad10a69558d15218af07ce8c34d234d2ff0946bc Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sun, 6 Apr 2025 13:36:45 +0000 Subject: [PATCH 5/8] chore(internal): more concise handling of parameter naming conflicts (#235) --- lib/orb/internal/type/base_model.rb | 9 +++------ lib/orb/models/alert_list_params.rb | 8 ++++---- lib/orb/models/credit_note_list_params.rb | 8 ++++---- lib/orb/models/customer_list_params.rb | 8 ++++---- .../customers/balance_transaction_list_params.rb | 8 ++++---- .../credits/ledger_list_by_external_id_params.rb | 8 ++++---- .../customers/credits/ledger_list_params.rb | 8 ++++---- lib/orb/models/invoice_list_params.rb | 16 ++++++++-------- lib/orb/models/metric_list_params.rb | 8 ++++---- lib/orb/models/plan_list_params.rb | 8 ++++---- .../models/subscription_fetch_schedule_params.rb | 8 ++++---- lib/orb/models/subscription_list_params.rb | 8 ++++---- lib/orb/resources/alerts.rb | 8 ++++---- lib/orb/resources/credit_notes.rb | 8 ++++---- lib/orb/resources/customers.rb | 8 ++++---- .../resources/customers/balance_transactions.rb | 8 ++++---- lib/orb/resources/customers/credits/ledger.rb | 16 ++++++++-------- lib/orb/resources/invoices.rb | 16 ++++++++-------- lib/orb/resources/metrics.rb | 8 ++++---- lib/orb/resources/plans.rb | 8 ++++---- lib/orb/resources/subscriptions.rb | 16 ++++++++-------- 21 files changed, 99 insertions(+), 102 deletions(-) diff --git a/lib/orb/internal/type/base_model.rb b/lib/orb/internal/type/base_model.rb index acdf613d..1250f71f 100644 --- a/lib/orb/internal/type/base_model.rb +++ b/lib/orb/internal/type/base_model.rb @@ -258,7 +258,6 @@ def dump(value) return super end - is_param = singleton_class <= Orb::Internal::Type::RequestParameters::Converter acc = {} coerced.each do |key, val| @@ -267,21 +266,19 @@ def dump(value) in nil acc.store(name, super(val)) else - mode, type_fn = field.fetch_values(:mode, :type_fn) + api_name, mode, type_fn = field.fetch_values(:api_name, :mode, :type_fn) case mode in :coerce next else target = type_fn.call - api_name = is_param ? name : field.fetch(:api_name) acc.store(api_name, Orb::Internal::Type::Converter.dump(target, val)) end end end - known_fields.each do |name, field| - mode, const = field.fetch_values(:mode, :const) - api_name = is_param ? name : field.fetch(:api_name) + known_fields.each_value do |field| + api_name, mode, const = field.fetch_values(:api_name, :mode, :const) next if mode == :coerce || acc.key?(api_name) || const == Orb::Internal::OMIT acc.store(api_name, const) end diff --git a/lib/orb/models/alert_list_params.rb b/lib/orb/models/alert_list_params.rb index 8132ed03..fd151d11 100644 --- a/lib/orb/models/alert_list_params.rb +++ b/lib/orb/models/alert_list_params.rb @@ -11,22 +11,22 @@ class AlertListParams < Orb::Internal::Type::BaseModel # @!attribute created_at_gt # # @return [Time, nil] - optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true + optional :created_at_gt, Time, nil?: true # @!attribute created_at_gte # # @return [Time, nil] - optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true + optional :created_at_gte, Time, nil?: true # @!attribute created_at_lt # # @return [Time, nil] - optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true + optional :created_at_lt, Time, nil?: true # @!attribute created_at_lte # # @return [Time, nil] - optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true + optional :created_at_lte, Time, nil?: true # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned diff --git a/lib/orb/models/credit_note_list_params.rb b/lib/orb/models/credit_note_list_params.rb index 7e634598..d1724176 100644 --- a/lib/orb/models/credit_note_list_params.rb +++ b/lib/orb/models/credit_note_list_params.rb @@ -11,22 +11,22 @@ class CreditNoteListParams < Orb::Internal::Type::BaseModel # @!attribute created_at_gt # # @return [Time, nil] - optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true + optional :created_at_gt, Time, nil?: true # @!attribute created_at_gte # # @return [Time, nil] - optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true + optional :created_at_gte, Time, nil?: true # @!attribute created_at_lt # # @return [Time, nil] - optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true + optional :created_at_lt, Time, nil?: true # @!attribute created_at_lte # # @return [Time, nil] - optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true + optional :created_at_lte, Time, nil?: true # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned diff --git a/lib/orb/models/customer_list_params.rb b/lib/orb/models/customer_list_params.rb index 181dd8a9..ad4411e7 100644 --- a/lib/orb/models/customer_list_params.rb +++ b/lib/orb/models/customer_list_params.rb @@ -11,22 +11,22 @@ class CustomerListParams < Orb::Internal::Type::BaseModel # @!attribute created_at_gt # # @return [Time, nil] - optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true + optional :created_at_gt, Time, nil?: true # @!attribute created_at_gte # # @return [Time, nil] - optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true + optional :created_at_gte, Time, nil?: true # @!attribute created_at_lt # # @return [Time, nil] - optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true + optional :created_at_lt, Time, nil?: true # @!attribute created_at_lte # # @return [Time, nil] - optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true + optional :created_at_lte, Time, nil?: true # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned diff --git a/lib/orb/models/customers/balance_transaction_list_params.rb b/lib/orb/models/customers/balance_transaction_list_params.rb index 7eb4ac10..8b7b7e23 100644 --- a/lib/orb/models/customers/balance_transaction_list_params.rb +++ b/lib/orb/models/customers/balance_transaction_list_params.rb @@ -29,22 +29,22 @@ class BalanceTransactionListParams < Orb::Internal::Type::BaseModel # @!attribute operation_time_gt # # @return [Time, nil] - optional :operation_time_gt, Time, api_name: :"operation_time[gt]", nil?: true + optional :operation_time_gt, Time, nil?: true # @!attribute operation_time_gte # # @return [Time, nil] - optional :operation_time_gte, Time, api_name: :"operation_time[gte]", nil?: true + optional :operation_time_gte, Time, nil?: true # @!attribute operation_time_lt # # @return [Time, nil] - optional :operation_time_lt, Time, api_name: :"operation_time[lt]", nil?: true + optional :operation_time_lt, Time, nil?: true # @!attribute operation_time_lte # # @return [Time, nil] - optional :operation_time_lte, Time, api_name: :"operation_time[lte]", nil?: true + optional :operation_time_lte, Time, nil?: true # @!parse # # @param cursor [String, nil] diff --git a/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb b/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb index 74320c75..f6c753ce 100644 --- a/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb @@ -13,22 +13,22 @@ class LedgerListByExternalIDParams < Orb::Internal::Type::BaseModel # @!attribute created_at_gt # # @return [Time, nil] - optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true + optional :created_at_gt, Time, nil?: true # @!attribute created_at_gte # # @return [Time, nil] - optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true + optional :created_at_gte, Time, nil?: true # @!attribute created_at_lt # # @return [Time, nil] - optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true + optional :created_at_lt, Time, nil?: true # @!attribute created_at_lte # # @return [Time, nil] - optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true + optional :created_at_lte, Time, nil?: true # @!attribute currency # The ledger currency or custom pricing unit to use. diff --git a/lib/orb/models/customers/credits/ledger_list_params.rb b/lib/orb/models/customers/credits/ledger_list_params.rb index d8da2b77..bbfb713b 100644 --- a/lib/orb/models/customers/credits/ledger_list_params.rb +++ b/lib/orb/models/customers/credits/ledger_list_params.rb @@ -13,22 +13,22 @@ class LedgerListParams < Orb::Internal::Type::BaseModel # @!attribute created_at_gt # # @return [Time, nil] - optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true + optional :created_at_gt, Time, nil?: true # @!attribute created_at_gte # # @return [Time, nil] - optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true + optional :created_at_gte, Time, nil?: true # @!attribute created_at_lt # # @return [Time, nil] - optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true + optional :created_at_lt, Time, nil?: true # @!attribute created_at_lte # # @return [Time, nil] - optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true + optional :created_at_lte, Time, nil?: true # @!attribute currency # The ledger currency or custom pricing unit to use. diff --git a/lib/orb/models/invoice_list_params.rb b/lib/orb/models/invoice_list_params.rb index ef15e63d..d733b10f 100644 --- a/lib/orb/models/invoice_list_params.rb +++ b/lib/orb/models/invoice_list_params.rb @@ -16,12 +16,12 @@ class InvoiceListParams < Orb::Internal::Type::BaseModel # @!attribute amount_gt # # @return [String, nil] - optional :amount_gt, String, api_name: :"amount[gt]", nil?: true + optional :amount_gt, String, nil?: true # @!attribute amount_lt # # @return [String, nil] - optional :amount_lt, String, api_name: :"amount[lt]", nil?: true + optional :amount_lt, String, nil?: true # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned @@ -57,12 +57,12 @@ class InvoiceListParams < Orb::Internal::Type::BaseModel # @!attribute due_date_gt # # @return [Date, nil] - optional :due_date_gt, Date, api_name: :"due_date[gt]", nil?: true + optional :due_date_gt, Date, nil?: true # @!attribute due_date_lt # # @return [Date, nil] - optional :due_date_lt, Date, api_name: :"due_date[lt]", nil?: true + optional :due_date_lt, Date, nil?: true # @!attribute external_customer_id # @@ -72,22 +72,22 @@ class InvoiceListParams < Orb::Internal::Type::BaseModel # @!attribute invoice_date_gt # # @return [Time, nil] - optional :invoice_date_gt, Time, api_name: :"invoice_date[gt]", nil?: true + optional :invoice_date_gt, Time, nil?: true # @!attribute invoice_date_gte # # @return [Time, nil] - optional :invoice_date_gte, Time, api_name: :"invoice_date[gte]", nil?: true + optional :invoice_date_gte, Time, nil?: true # @!attribute invoice_date_lt # # @return [Time, nil] - optional :invoice_date_lt, Time, api_name: :"invoice_date[lt]", nil?: true + optional :invoice_date_lt, Time, nil?: true # @!attribute invoice_date_lte # # @return [Time, nil] - optional :invoice_date_lte, Time, api_name: :"invoice_date[lte]", nil?: true + optional :invoice_date_lte, Time, nil?: true # @!attribute is_recurring # diff --git a/lib/orb/models/metric_list_params.rb b/lib/orb/models/metric_list_params.rb index 50f7e8a1..b00bee14 100644 --- a/lib/orb/models/metric_list_params.rb +++ b/lib/orb/models/metric_list_params.rb @@ -11,22 +11,22 @@ class MetricListParams < Orb::Internal::Type::BaseModel # @!attribute created_at_gt # # @return [Time, nil] - optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true + optional :created_at_gt, Time, nil?: true # @!attribute created_at_gte # # @return [Time, nil] - optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true + optional :created_at_gte, Time, nil?: true # @!attribute created_at_lt # # @return [Time, nil] - optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true + optional :created_at_lt, Time, nil?: true # @!attribute created_at_lte # # @return [Time, nil] - optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true + optional :created_at_lte, Time, nil?: true # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned diff --git a/lib/orb/models/plan_list_params.rb b/lib/orb/models/plan_list_params.rb index 5d20d996..f931e614 100644 --- a/lib/orb/models/plan_list_params.rb +++ b/lib/orb/models/plan_list_params.rb @@ -11,22 +11,22 @@ class PlanListParams < Orb::Internal::Type::BaseModel # @!attribute created_at_gt # # @return [Time, nil] - optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true + optional :created_at_gt, Time, nil?: true # @!attribute created_at_gte # # @return [Time, nil] - optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true + optional :created_at_gte, Time, nil?: true # @!attribute created_at_lt # # @return [Time, nil] - optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true + optional :created_at_lt, Time, nil?: true # @!attribute created_at_lte # # @return [Time, nil] - optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true + optional :created_at_lte, Time, nil?: true # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned diff --git a/lib/orb/models/subscription_fetch_schedule_params.rb b/lib/orb/models/subscription_fetch_schedule_params.rb index ddaf3eba..68acd23d 100644 --- a/lib/orb/models/subscription_fetch_schedule_params.rb +++ b/lib/orb/models/subscription_fetch_schedule_params.rb @@ -28,22 +28,22 @@ class SubscriptionFetchScheduleParams < Orb::Internal::Type::BaseModel # @!attribute start_date_gt # # @return [Time, nil] - optional :start_date_gt, Time, api_name: :"start_date[gt]", nil?: true + optional :start_date_gt, Time, nil?: true # @!attribute start_date_gte # # @return [Time, nil] - optional :start_date_gte, Time, api_name: :"start_date[gte]", nil?: true + optional :start_date_gte, Time, nil?: true # @!attribute start_date_lt # # @return [Time, nil] - optional :start_date_lt, Time, api_name: :"start_date[lt]", nil?: true + optional :start_date_lt, Time, nil?: true # @!attribute start_date_lte # # @return [Time, nil] - optional :start_date_lte, Time, api_name: :"start_date[lte]", nil?: true + optional :start_date_lte, Time, nil?: true # @!parse # # @param cursor [String, nil] diff --git a/lib/orb/models/subscription_list_params.rb b/lib/orb/models/subscription_list_params.rb index eb083b28..de1241b9 100644 --- a/lib/orb/models/subscription_list_params.rb +++ b/lib/orb/models/subscription_list_params.rb @@ -11,22 +11,22 @@ class SubscriptionListParams < Orb::Internal::Type::BaseModel # @!attribute created_at_gt # # @return [Time, nil] - optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true + optional :created_at_gt, Time, nil?: true # @!attribute created_at_gte # # @return [Time, nil] - optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true + optional :created_at_gte, Time, nil?: true # @!attribute created_at_lt # # @return [Time, nil] - optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true + optional :created_at_lt, Time, nil?: true # @!attribute created_at_lte # # @return [Time, nil] - optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true + optional :created_at_lte, Time, nil?: true # @!attribute cursor # Cursor for pagination. This can be populated by the `next_cursor` value returned diff --git a/lib/orb/resources/alerts.rb b/lib/orb/resources/alerts.rb index 14e8313a..8f41716e 100644 --- a/lib/orb/resources/alerts.rb +++ b/lib/orb/resources/alerts.rb @@ -78,10 +78,10 @@ def list(params = {}) method: :get, path: "alerts", query: parsed.transform_keys( - created_at_gt: :"created_at[gt]", - created_at_gte: :"created_at[gte]", - created_at_lt: :"created_at[lt]", - created_at_lte: :"created_at[lte]" + created_at_gt: "created_at[gt]", + created_at_gte: "created_at[gte]", + created_at_lt: "created_at[lt]", + created_at_lte: "created_at[lte]" ), page: Orb::Internal::Page, model: Orb::Models::Alert, diff --git a/lib/orb/resources/credit_notes.rb b/lib/orb/resources/credit_notes.rb index f11cc7fb..835b9e9d 100644 --- a/lib/orb/resources/credit_notes.rb +++ b/lib/orb/resources/credit_notes.rb @@ -50,10 +50,10 @@ def list(params = {}) method: :get, path: "credit_notes", query: parsed.transform_keys( - created_at_gt: :"created_at[gt]", - created_at_gte: :"created_at[gte]", - created_at_lt: :"created_at[lt]", - created_at_lte: :"created_at[lte]" + created_at_gt: "created_at[gt]", + created_at_gte: "created_at[gte]", + created_at_lt: "created_at[lt]", + created_at_lte: "created_at[lte]" ), page: Orb::Internal::Page, model: Orb::Models::CreditNote, diff --git a/lib/orb/resources/customers.rb b/lib/orb/resources/customers.rb index 0ffc8635..4020803d 100644 --- a/lib/orb/resources/customers.rb +++ b/lib/orb/resources/customers.rb @@ -129,10 +129,10 @@ def list(params = {}) method: :get, path: "customers", query: parsed.transform_keys( - created_at_gt: :"created_at[gt]", - created_at_gte: :"created_at[gte]", - created_at_lt: :"created_at[lt]", - created_at_lte: :"created_at[lte]" + created_at_gt: "created_at[gt]", + created_at_gte: "created_at[gte]", + created_at_lt: "created_at[lt]", + created_at_lte: "created_at[lte]" ), page: Orb::Internal::Page, model: Orb::Models::Customer, diff --git a/lib/orb/resources/customers/balance_transactions.rb b/lib/orb/resources/customers/balance_transactions.rb index 9a189f77..99112b00 100644 --- a/lib/orb/resources/customers/balance_transactions.rb +++ b/lib/orb/resources/customers/balance_transactions.rb @@ -78,10 +78,10 @@ def list(customer_id, params = {}) method: :get, path: ["customers/%1$s/balance_transactions", customer_id], query: parsed.transform_keys( - operation_time_gt: :"operation_time[gt]", - operation_time_gte: :"operation_time[gte]", - operation_time_lt: :"operation_time[lt]", - operation_time_lte: :"operation_time[lte]" + operation_time_gt: "operation_time[gt]", + operation_time_gte: "operation_time[gte]", + operation_time_lt: "operation_time[lt]", + operation_time_lte: "operation_time[lte]" ), page: Orb::Internal::Page, model: Orb::Models::Customers::BalanceTransactionListResponse, diff --git a/lib/orb/resources/customers/credits/ledger.rb b/lib/orb/resources/customers/credits/ledger.rb index f379f7ac..60f2f474 100644 --- a/lib/orb/resources/customers/credits/ledger.rb +++ b/lib/orb/resources/customers/credits/ledger.rb @@ -111,10 +111,10 @@ def list(customer_id, params = {}) method: :get, path: ["customers/%1$s/credits/ledger", customer_id], query: parsed.transform_keys( - created_at_gt: :"created_at[gt]", - created_at_gte: :"created_at[gte]", - created_at_lt: :"created_at[lt]", - created_at_lte: :"created_at[lte]" + created_at_gt: "created_at[gt]", + created_at_gte: "created_at[gte]", + created_at_lt: "created_at[lt]", + created_at_lte: "created_at[lte]" ), page: Orb::Internal::Page, model: Orb::Models::Customers::Credits::LedgerListResponse, @@ -513,10 +513,10 @@ def list_by_external_id(external_customer_id, params = {}) method: :get, path: ["customers/external_customer_id/%1$s/credits/ledger", external_customer_id], query: parsed.transform_keys( - created_at_gt: :"created_at[gt]", - created_at_gte: :"created_at[gte]", - created_at_lt: :"created_at[lt]", - created_at_lte: :"created_at[lte]" + created_at_gt: "created_at[gt]", + created_at_gte: "created_at[gte]", + created_at_lt: "created_at[lt]", + created_at_lte: "created_at[lte]" ), page: Orb::Internal::Page, model: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse, diff --git a/lib/orb/resources/invoices.rb b/lib/orb/resources/invoices.rb index 32905168..5401a78d 100644 --- a/lib/orb/resources/invoices.rb +++ b/lib/orb/resources/invoices.rb @@ -105,14 +105,14 @@ def list(params = {}) method: :get, path: "invoices", query: parsed.transform_keys( - amount_gt: :"amount[gt]", - amount_lt: :"amount[lt]", - due_date_gt: :"due_date[gt]", - due_date_lt: :"due_date[lt]", - invoice_date_gt: :"invoice_date[gt]", - invoice_date_gte: :"invoice_date[gte]", - invoice_date_lt: :"invoice_date[lt]", - invoice_date_lte: :"invoice_date[lte]" + amount_gt: "amount[gt]", + amount_lt: "amount[lt]", + due_date_gt: "due_date[gt]", + due_date_lt: "due_date[lt]", + invoice_date_gt: "invoice_date[gt]", + invoice_date_gte: "invoice_date[gte]", + invoice_date_lt: "invoice_date[lt]", + invoice_date_lte: "invoice_date[lte]" ), page: Orb::Internal::Page, model: Orb::Models::Invoice, diff --git a/lib/orb/resources/metrics.rb b/lib/orb/resources/metrics.rb index 3a58a27f..55c071f3 100644 --- a/lib/orb/resources/metrics.rb +++ b/lib/orb/resources/metrics.rb @@ -77,10 +77,10 @@ def list(params = {}) method: :get, path: "metrics", query: parsed.transform_keys( - created_at_gt: :"created_at[gt]", - created_at_gte: :"created_at[gte]", - created_at_lt: :"created_at[lt]", - created_at_lte: :"created_at[lte]" + created_at_gt: "created_at[gt]", + created_at_gte: "created_at[gte]", + created_at_lt: "created_at[lt]", + created_at_lte: "created_at[lte]" ), page: Orb::Internal::Page, model: Orb::Models::BillableMetric, diff --git a/lib/orb/resources/plans.rb b/lib/orb/resources/plans.rb index e3d689d3..b4defc43 100644 --- a/lib/orb/resources/plans.rb +++ b/lib/orb/resources/plans.rb @@ -80,10 +80,10 @@ def list(params = {}) method: :get, path: "plans", query: parsed.transform_keys( - created_at_gt: :"created_at[gt]", - created_at_gte: :"created_at[gte]", - created_at_lt: :"created_at[lt]", - created_at_lte: :"created_at[lte]" + created_at_gt: "created_at[gt]", + created_at_gte: "created_at[gte]", + created_at_lt: "created_at[lt]", + created_at_lte: "created_at[lte]" ), page: Orb::Internal::Page, model: Orb::Models::Plan, diff --git a/lib/orb/resources/subscriptions.rb b/lib/orb/resources/subscriptions.rb index b8683446..7eec8163 100644 --- a/lib/orb/resources/subscriptions.rb +++ b/lib/orb/resources/subscriptions.rb @@ -369,10 +369,10 @@ def list(params = {}) method: :get, path: "subscriptions", query: parsed.transform_keys( - created_at_gt: :"created_at[gt]", - created_at_gte: :"created_at[gte]", - created_at_lt: :"created_at[lt]", - created_at_lte: :"created_at[lte]" + created_at_gt: "created_at[gt]", + created_at_gte: "created_at[gte]", + created_at_lt: "created_at[lt]", + created_at_lte: "created_at[lte]" ), page: Orb::Internal::Page, model: Orb::Models::Subscription, @@ -543,10 +543,10 @@ def fetch_schedule(subscription_id, params = {}) method: :get, path: ["subscriptions/%1$s/schedule", subscription_id], query: parsed.transform_keys( - start_date_gt: :"start_date[gt]", - start_date_gte: :"start_date[gte]", - start_date_lt: :"start_date[lt]", - start_date_lte: :"start_date[lte]" + start_date_gt: "start_date[gt]", + start_date_gte: "start_date[gte]", + start_date_lt: "start_date[lt]", + start_date_lte: "start_date[lte]" ), page: Orb::Internal::Page, model: Orb::Models::SubscriptionFetchScheduleResponse, From 8cf1bc47517a9262cbd58bf8c915b6a94b77cc96 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 7 Apr 2025 19:39:48 +0000 Subject: [PATCH 6/8] chore(internal): codegen related update (#236) --- .stats.yml | 2 +- lib/orb/resources/customers.rb | 22 +++++++++++----------- rbi/lib/orb/resources/customers.rbi | 12 ++++++++---- sig/orb/resources/customers.rbs | 4 ++-- test/orb/resources/customers_test.rb | 5 +++-- 5 files changed, 25 insertions(+), 20 deletions(-) diff --git a/.stats.yml b/.stats.yml index f2253470..1e64c91b 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 103 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-95a3d7780935a38e0cf076d4ad2d68bd1a5641bced8398d972db2e92751d364a.yml openapi_spec_hash: 9ebe818c4ad4f2d9c4e473b5192d7544 -config_hash: 3dc5bc1df028fc7301fb2ada9846f038 +config_hash: 54edf41f0377bc235f622fdaa7405f22 diff --git a/lib/orb/resources/customers.rb b/lib/orb/resources/customers.rb index 4020803d..c7932ea5 100644 --- a/lib/orb/resources/customers.rb +++ b/lib/orb/resources/customers.rb @@ -227,21 +227,18 @@ def fetch_by_external_id(external_customer_id, params = {}) # # **Note**: This functionality is currently only available for Stripe. # - # @overload sync_payment_methods_from_gateway(external_customer_id, request_options: {}) + # @overload sync_payment_methods_from_gateway(customer_id, request_options: {}) # - # @param external_customer_id [String] + # @param customer_id [String] # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # # @see Orb::Models::CustomerSyncPaymentMethodsFromGatewayParams - def sync_payment_methods_from_gateway(external_customer_id, params = {}) + def sync_payment_methods_from_gateway(customer_id, params = {}) @client.request( method: :post, - path: [ - "customers/external_customer_id/%1$s/sync_payment_methods_from_gateway", - external_customer_id - ], + path: ["customers/%1$s/sync_payment_methods_from_gateway", customer_id], model: NilClass, options: params[:request_options] ) @@ -254,18 +251,21 @@ def sync_payment_methods_from_gateway(external_customer_id, params = {}) # # **Note**: This functionality is currently only available for Stripe. # - # @overload sync_payment_methods_from_gateway_by_external_customer_id(customer_id, request_options: {}) + # @overload sync_payment_methods_from_gateway_by_external_customer_id(external_customer_id, request_options: {}) # - # @param customer_id [String] + # @param external_customer_id [String] # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # # @see Orb::Models::CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams - def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, params = {}) + def sync_payment_methods_from_gateway_by_external_customer_id(external_customer_id, params = {}) @client.request( method: :post, - path: ["customers/%1$s/sync_payment_methods_from_gateway", customer_id], + path: [ + "customers/external_customer_id/%1$s/sync_payment_methods_from_gateway", + external_customer_id + ], model: NilClass, options: params[:request_options] ) diff --git a/rbi/lib/orb/resources/customers.rbi b/rbi/lib/orb/resources/customers.rbi index 44037d79..22392de3 100644 --- a/rbi/lib/orb/resources/customers.rbi +++ b/rbi/lib/orb/resources/customers.rbi @@ -482,12 +482,12 @@ module Orb # **Note**: This functionality is currently only available for Stripe. sig do params( - external_customer_id: String, + customer_id: String, request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) ) .void end - def sync_payment_methods_from_gateway(external_customer_id, request_options: {}); end + def sync_payment_methods_from_gateway(customer_id, request_options: {}); end # Sync Orb's payment methods for the customer with their gateway. # @@ -497,12 +497,16 @@ module Orb # **Note**: This functionality is currently only available for Stripe. sig do params( - customer_id: String, + external_customer_id: String, request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) ) .void end - def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, request_options: {}); end + def sync_payment_methods_from_gateway_by_external_customer_id( + external_customer_id, + request_options: {} + ) + end # This endpoint is used to update customer details given an `external_customer_id` # (see [Customer ID Aliases](/events-and-metrics/customer-aliases)). Note that the diff --git a/sig/orb/resources/customers.rbs b/sig/orb/resources/customers.rbs index ec60eaa1..a12e8327 100644 --- a/sig/orb/resources/customers.rbs +++ b/sig/orb/resources/customers.rbs @@ -77,12 +77,12 @@ module Orb ) -> Orb::Models::Customer def sync_payment_methods_from_gateway: ( - String external_customer_id, + String customer_id, ?request_options: Orb::request_opts ) -> nil def sync_payment_methods_from_gateway_by_external_customer_id: ( - String customer_id, + String external_customer_id, ?request_options: Orb::request_opts ) -> nil diff --git a/test/orb/resources/customers_test.rb b/test/orb/resources/customers_test.rb index c05c8fc7..8c3ebed0 100644 --- a/test/orb/resources/customers_test.rb +++ b/test/orb/resources/customers_test.rb @@ -194,7 +194,7 @@ def test_fetch_by_external_id end def test_sync_payment_methods_from_gateway - response = @orb.customers.sync_payment_methods_from_gateway("external_customer_id") + response = @orb.customers.sync_payment_methods_from_gateway("customer_id") assert_pattern do response => nil @@ -202,7 +202,8 @@ def test_sync_payment_methods_from_gateway end def test_sync_payment_methods_from_gateway_by_external_customer_id - response = @orb.customers.sync_payment_methods_from_gateway_by_external_customer_id("customer_id") + response = + @orb.customers.sync_payment_methods_from_gateway_by_external_customer_id("external_customer_id") assert_pattern do response => nil From 0bb6400deb4cb2ab6959e45ca9a53bc51e040d7a Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 7 Apr 2025 22:09:20 +0000 Subject: [PATCH 7/8] feat(api): api update (#237) --- .stats.yml | 8 +- lib/orb.rb | 7 + lib/orb/client.rb | 4 + lib/orb/models/invoice_create_params.rb | 5 +- lib/orb/models/plan_create_params.rb | 8 +- lib/orb/models/price.rb | 8 +- lib/orb/models/price_create_params.rb | 8 +- lib/orb/models/subscription.rb | 27 + .../models/subscription_cancel_response.rb | 78 + .../subscription_change_apply_params.rb | 33 + .../subscription_change_apply_response.rb | 1372 ++++++++++++++ .../subscription_change_cancel_params.rb | 19 + .../subscription_change_cancel_response.rb | 1372 ++++++++++++++ .../subscription_change_retrieve_params.rb | 19 + .../subscription_change_retrieve_response.rb | 1372 ++++++++++++++ lib/orb/models/subscription_create_params.rb | 16 +- .../models/subscription_create_response.rb | 78 + .../subscription_price_intervals_params.rb | 8 +- .../subscription_price_intervals_response.rb | 80 + ...ubscription_schedule_plan_change_params.rb | 16 +- ...scription_schedule_plan_change_response.rb | 80 + .../subscription_trigger_phase_response.rb | 80 + ...iption_unschedule_cancellation_response.rb | 80 + ...ule_fixed_fee_quantity_updates_response.rb | 80 + ...nschedule_pending_plan_changes_response.rb | 80 + ...tion_update_fixed_fee_quantity_response.rb | 80 + .../subscription_update_trial_response.rb | 80 + lib/orb/resources/subscription_changes.rb | 87 + rbi/lib/orb/client.rbi | 3 + rbi/lib/orb/models/invoice_create_params.rbi | 5 +- rbi/lib/orb/models/plan_create_params.rbi | 8 +- rbi/lib/orb/models/price.rbi | 8 +- rbi/lib/orb/models/price_create_params.rbi | 8 +- rbi/lib/orb/models/subscription.rbi | 27 + .../models/subscription_cancel_response.rbi | 99 +- .../subscription_change_apply_params.rbi | 40 + .../subscription_change_apply_response.rbi | 1554 ++++++++++++++++ .../subscription_change_cancel_params.rbi | 18 + .../subscription_change_cancel_response.rbi | 1565 ++++++++++++++++ .../subscription_change_retrieve_params.rbi | 18 + .../subscription_change_retrieve_response.rbi | 1581 +++++++++++++++++ .../orb/models/subscription_create_params.rbi | 16 +- .../models/subscription_create_response.rbi | 99 +- .../subscription_price_intervals_params.rbi | 8 +- .../subscription_price_intervals_response.rbi | 103 +- ...bscription_schedule_plan_change_params.rbi | 16 +- ...cription_schedule_plan_change_response.rbi | 109 +- .../subscription_trigger_phase_response.rbi | 99 +- ...ption_unschedule_cancellation_response.rbi | 109 +- ...le_fixed_fee_quantity_updates_response.rbi | 117 +- ...schedule_pending_plan_changes_response.rbi | 119 +- ...ion_update_fixed_fee_quantity_response.rbi | 109 +- .../subscription_update_trial_response.rbi | 99 +- rbi/lib/orb/resources/invoices.rbi | 5 +- .../orb/resources/subscription_changes.rbi | 61 + sig/orb/client.rbs | 2 + sig/orb/models/subscription.rbs | 14 + .../models/subscription_cancel_response.rbs | 49 +- .../subscription_change_apply_params.rbs | 24 + .../subscription_change_apply_response.rbs | 784 ++++++++ .../subscription_change_cancel_params.rbs | 15 + .../subscription_change_cancel_response.rbs | 784 ++++++++ .../subscription_change_retrieve_params.rbs | 15 + .../subscription_change_retrieve_response.rbs | 784 ++++++++ .../models/subscription_create_response.rbs | 49 +- .../subscription_price_intervals_response.rbs | 49 +- ...cription_schedule_plan_change_response.rbs | 49 +- .../subscription_trigger_phase_response.rbs | 49 +- ...ption_unschedule_cancellation_response.rbs | 49 +- ...le_fixed_fee_quantity_updates_response.rbs | 49 +- ...schedule_pending_plan_changes_response.rbs | 49 +- ...ion_update_fixed_fee_quantity_response.rbs | 49 +- .../subscription_update_trial_response.rbs | 49 +- sig/orb/resources/subscription_changes.rbs | 24 + .../resources/coupons/subscriptions_test.rb | 1 + .../resources/subscription_changes_test.rb | 62 + test/orb/resources/subscriptions_test.rb | 43 +- 77 files changed, 14097 insertions(+), 133 deletions(-) create mode 100644 lib/orb/models/subscription_change_apply_params.rb create mode 100644 lib/orb/models/subscription_change_apply_response.rb create mode 100644 lib/orb/models/subscription_change_cancel_params.rb create mode 100644 lib/orb/models/subscription_change_cancel_response.rb create mode 100644 lib/orb/models/subscription_change_retrieve_params.rb create mode 100644 lib/orb/models/subscription_change_retrieve_response.rb create mode 100644 lib/orb/resources/subscription_changes.rb create mode 100644 rbi/lib/orb/models/subscription_change_apply_params.rbi create mode 100644 rbi/lib/orb/models/subscription_change_apply_response.rbi create mode 100644 rbi/lib/orb/models/subscription_change_cancel_params.rbi create mode 100644 rbi/lib/orb/models/subscription_change_cancel_response.rbi create mode 100644 rbi/lib/orb/models/subscription_change_retrieve_params.rbi create mode 100644 rbi/lib/orb/models/subscription_change_retrieve_response.rbi create mode 100644 rbi/lib/orb/resources/subscription_changes.rbi create mode 100644 sig/orb/models/subscription_change_apply_params.rbs create mode 100644 sig/orb/models/subscription_change_apply_response.rbs create mode 100644 sig/orb/models/subscription_change_cancel_params.rbs create mode 100644 sig/orb/models/subscription_change_cancel_response.rbs create mode 100644 sig/orb/models/subscription_change_retrieve_params.rbs create mode 100644 sig/orb/models/subscription_change_retrieve_response.rbs create mode 100644 sig/orb/resources/subscription_changes.rbs create mode 100644 test/orb/resources/subscription_changes_test.rb diff --git a/.stats.yml b/.stats.yml index 1e64c91b..88277273 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 103 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-95a3d7780935a38e0cf076d4ad2d68bd1a5641bced8398d972db2e92751d364a.yml -openapi_spec_hash: 9ebe818c4ad4f2d9c4e473b5192d7544 -config_hash: 54edf41f0377bc235f622fdaa7405f22 +configured_endpoints: 106 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-e8dad7eee5621fe2ba948dfd00dabf170d9d92ce615a9f04b0f546f4d8bf39ba.yml +openapi_spec_hash: 3f6a98e3a1b3a47acebd67a960090ebf +config_hash: 7e523cf79552b8936bd772f2e1025e5f diff --git a/lib/orb.rb b/lib/orb.rb index 81290f0f..312f283f 100644 --- a/lib/orb.rb +++ b/lib/orb.rb @@ -188,6 +188,12 @@ require_relative "orb/models/subscription" require_relative "orb/models/subscription_cancel_params" require_relative "orb/models/subscription_cancel_response" +require_relative "orb/models/subscription_change_apply_params" +require_relative "orb/models/subscription_change_apply_response" +require_relative "orb/models/subscription_change_cancel_params" +require_relative "orb/models/subscription_change_cancel_response" +require_relative "orb/models/subscription_change_retrieve_params" +require_relative "orb/models/subscription_change_retrieve_response" require_relative "orb/models/subscription_create_params" require_relative "orb/models/subscription_create_response" require_relative "orb/models/subscription_fetch_costs_params" @@ -243,5 +249,6 @@ require_relative "orb/resources/plans/external_plan_id" require_relative "orb/resources/prices" require_relative "orb/resources/prices/external_price_id" +require_relative "orb/resources/subscription_changes" require_relative "orb/resources/subscriptions" require_relative "orb/resources/top_level" diff --git a/lib/orb/client.rb b/lib/orb/client.rb index d0cc576f..318b4994 100644 --- a/lib/orb/client.rb +++ b/lib/orb/client.rb @@ -60,6 +60,9 @@ class Client < Orb::Internal::Transport::BaseClient # @return [Orb::Resources::DimensionalPriceGroups] attr_reader :dimensional_price_groups + # @return [Orb::Resources::SubscriptionChanges] + attr_reader :subscription_changes + # @api private # # @return [Hash{String=>String}] @@ -124,6 +127,7 @@ def initialize( @subscriptions = Orb::Resources::Subscriptions.new(client: self) @alerts = Orb::Resources::Alerts.new(client: self) @dimensional_price_groups = Orb::Resources::DimensionalPriceGroups.new(client: self) + @subscription_changes = Orb::Resources::SubscriptionChanges.new(client: self) end end end diff --git a/lib/orb/models/invoice_create_params.rb b/lib/orb/models/invoice_create_params.rb index db524a34..8f92bf66 100644 --- a/lib/orb/models/invoice_create_params.rb +++ b/lib/orb/models/invoice_create_params.rb @@ -71,8 +71,9 @@ class InvoiceCreateParams < Orb::Internal::Type::BaseModel optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true # @!attribute [r] will_auto_issue - # When true, this invoice will automatically be issued upon creation. When false, - # the resulting invoice will require manual review to issue. Defaulted to false. + # When true, this invoice will be submitted for issuance upon creation. When + # false, the resulting invoice will require manual review to issue. Defaulted to + # false. # # @return [Boolean, nil] optional :will_auto_issue, Orb::Internal::Type::Boolean diff --git a/lib/orb/models/plan_create_params.rb b/lib/orb/models/plan_create_params.rb index 99d40d8e..d659f4a3 100644 --- a/lib/orb/models/plan_create_params.rb +++ b/lib/orb/models/plan_create_params.rb @@ -1176,7 +1176,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit - # Inclusive tier starting value + # Exclusive tier starting value # # @return [Float] required :first_unit, Float @@ -1188,7 +1188,7 @@ class Tier < Orb::Internal::Type::BaseModel required :unit_amount, String # @!attribute last_unit - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier # # @return [Float, nil] optional :last_unit, Float, nil?: true @@ -1478,13 +1478,13 @@ class Tier < Orb::Internal::Type::BaseModel required :bps, Float # @!attribute minimum_amount - # Inclusive tier starting value + # Exclusive tier starting value # # @return [String] required :minimum_amount, String # @!attribute maximum_amount - # Exclusive tier ending value + # Inclusive tier ending value # # @return [String, nil] optional :maximum_amount, String, nil?: true diff --git a/lib/orb/models/price.rb b/lib/orb/models/price.rb index 21cab189..398f692e 100644 --- a/lib/orb/models/price.rb +++ b/lib/orb/models/price.rb @@ -1838,7 +1838,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit - # Inclusive tier starting value + # Exclusive tier starting value # # @return [Float] required :first_unit, Float @@ -1850,7 +1850,7 @@ class Tier < Orb::Internal::Type::BaseModel required :unit_amount, String # @!attribute last_unit - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier # # @return [Float, nil] optional :last_unit, Float, nil?: true @@ -2310,13 +2310,13 @@ class Tier < Orb::Internal::Type::BaseModel required :bps, Float # @!attribute minimum_amount - # Inclusive tier starting value + # Exclusive tier starting value # # @return [String] required :minimum_amount, String # @!attribute maximum_amount - # Exclusive tier ending value + # Inclusive tier ending value # # @return [String, nil] optional :maximum_amount, String, nil?: true diff --git a/lib/orb/models/price_create_params.rb b/lib/orb/models/price_create_params.rb index db287356..4a5f01f1 100644 --- a/lib/orb/models/price_create_params.rb +++ b/lib/orb/models/price_create_params.rb @@ -624,7 +624,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit - # Inclusive tier starting value + # Exclusive tier starting value # # @return [Float] required :first_unit, Float @@ -636,7 +636,7 @@ class Tier < Orb::Internal::Type::BaseModel required :unit_amount, String # @!attribute last_unit - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier # # @return [Float, nil] optional :last_unit, Float, nil?: true @@ -676,13 +676,13 @@ class Tier < Orb::Internal::Type::BaseModel required :bps, Float # @!attribute minimum_amount - # Inclusive tier starting value + # Exclusive tier starting value # # @return [String] required :minimum_amount, String # @!attribute maximum_amount - # Exclusive tier ending value + # Inclusive tier ending value # # @return [String, nil] optional :maximum_amount, String, nil?: true diff --git a/lib/orb/models/subscription.rb b/lib/orb/models/subscription.rb index fe0956b3..5993bc97 100644 --- a/lib/orb/models/subscription.rb +++ b/lib/orb/models/subscription.rb @@ -154,6 +154,14 @@ class Subscription < Orb::Internal::Type::BaseModel # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::Subscription::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::Subscription::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -230,6 +238,7 @@ class Subscription < Orb::Internal::Type::BaseModel # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil] @@ -257,6 +266,7 @@ class Subscription < Orb::Internal::Type::BaseModel # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, @@ -1036,6 +1046,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::Subscription#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_cancel_response.rb b/lib/orb/models/subscription_cancel_response.rb index 47a83381..e095986d 100644 --- a/lib/orb/models/subscription_cancel_response.rb +++ b/lib/orb/models/subscription_cancel_response.rb @@ -154,6 +154,14 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -191,6 +199,14 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # @return [Orb::Models::SubscriptionCancelResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionCancelResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionCancelResponse::ChangedResources, nil] + optional :changed_resources, -> { Orb::Models::SubscriptionCancelResponse::ChangedResources }, nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -211,12 +227,14 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionCancelResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionCancelResponse::Status] # # @param trial_info [Orb::Models::SubscriptionCancelResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionCancelResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -238,12 +256,14 @@ class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1019,6 +1039,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionCancelResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1215,6 +1252,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionCancelResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/models/subscription_change_apply_params.rb b/lib/orb/models/subscription_change_apply_params.rb new file mode 100644 index 00000000..a20f0e4b --- /dev/null +++ b/lib/orb/models/subscription_change_apply_params.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +module Orb + module Models + # @see Orb::Resources::SubscriptionChanges#apply + class SubscriptionChangeApplyParams < Orb::Internal::Type::BaseModel + # @!parse + # extend Orb::Internal::Type::RequestParameters::Converter + include Orb::Internal::Type::RequestParameters + + # @!attribute description + # Description to apply to the balance transaction representing this credit. + # + # @return [String, nil] + optional :description, String, nil?: true + + # @!attribute previously_collected_amount + # Amount already collected to apply to the customer's balance. + # + # @return [String, nil] + optional :previously_collected_amount, String, nil?: true + + # @!parse + # # @param description [String, nil] + # # @param previously_collected_amount [String, nil] + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] + # # + # def initialize(description: nil, previously_collected_amount: nil, request_options: {}, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + end +end diff --git a/lib/orb/models/subscription_change_apply_response.rb b/lib/orb/models/subscription_change_apply_response.rb new file mode 100644 index 00000000..0317ff4f --- /dev/null +++ b/lib/orb/models/subscription_change_apply_response.rb @@ -0,0 +1,1372 @@ +# frozen_string_literal: true + +module Orb + module Models + # @see Orb::Resources::SubscriptionChanges#apply + class SubscriptionChangeApplyResponse < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute expiration_time + # Subscription change will be cancelled at this time and can no longer be applied. + # + # @return [Time] + required :expiration_time, Time + + # @!attribute status + # + # @return [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Status] + required :status, enum: -> { Orb::Models::SubscriptionChangeApplyResponse::Status } + + # @!attribute subscription + # + # @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription, nil] + required :subscription, -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription }, nil?: true + + # @!attribute applied_at + # When this change was applied. + # + # @return [Time, nil] + optional :applied_at, Time, nil?: true + + # @!attribute cancelled_at + # When this change was cancelled. + # + # @return [Time, nil] + optional :cancelled_at, Time, nil?: true + + # @!parse + # # A subscription change represents a desired new subscription / pending change to + # # an existing subscription. It is a way to first preview the effects on the + # # subscription as well as any changes/creation of invoices (see + # # `subscription.changed_resources`). + # # + # # @param id [String] + # # @param expiration_time [Time] + # # @param status [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Status] + # # @param subscription [Orb::Models::SubscriptionChangeApplyResponse::Subscription, nil] + # # @param applied_at [Time, nil] + # # @param cancelled_at [Time, nil] + # # + # def initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + # @see Orb::Models::SubscriptionChangeApplyResponse#status + module Status + extend Orb::Internal::Type::Enum + + PENDING = :pending + APPLIED = :applied + CANCELLED = :cancelled + + finalize! + + # @!parse + # # @return [Array] + # def self.values; end + end + + # @see Orb::Models::SubscriptionChangeApplyResponse#subscription + class Subscription < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute active_plan_phase_order + # The current plan phase that is active, only if the subscription's plan has + # phases. + # + # @return [Integer, nil] + required :active_plan_phase_order, Integer, nil?: true + + # @!attribute adjustment_intervals + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. + # + # @return [Array] + required :adjustment_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval] } + + # @!attribute auto_collection + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. + # + # @return [Boolean, nil] + required :auto_collection, Orb::Internal::Type::Boolean, nil?: true + + # @!attribute billing_cycle_anchor_configuration + # + # @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration] + required :billing_cycle_anchor_configuration, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration } + + # @!attribute billing_cycle_day + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + # + # @return [Integer] + required :billing_cycle_day, Integer + + # @!attribute created_at + # + # @return [Time] + required :created_at, Time + + # @!attribute current_billing_period_end_date + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. + # + # @return [Time, nil] + required :current_billing_period_end_date, Time, nil?: true + + # @!attribute current_billing_period_start_date + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. + # + # @return [Time, nil] + required :current_billing_period_start_date, Time, nil?: true + + # @!attribute customer + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. + # + # @return [Orb::Models::Customer] + required :customer, -> { Orb::Models::Customer } + + # @!attribute default_invoice_memo + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. + # + # @return [String, nil] + required :default_invoice_memo, String, nil?: true + + # @!attribute discount_intervals + # The discount intervals for this subscription sorted by the start_date. + # + # @return [Array] + required :discount_intervals, + -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval] } + + # @!attribute end_date + # The date Orb stops billing for this subscription. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute fixed_fee_quantity_schedule + # + # @return [Array] + required :fixed_fee_quantity_schedule, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeApplyResponse::Subscription::FixedFeeQuantitySchedule] } + + # @!attribute invoicing_threshold + # + # @return [String, nil] + required :invoicing_threshold, String, nil?: true + + # @!attribute maximum_intervals + # The maximum intervals for this subscription sorted by the start_date. + # + # @return [Array] + required :maximum_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval] } + + # @!attribute metadata + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. + # + # @return [Hash{Symbol=>String}] + required :metadata, Orb::Internal::Type::HashOf[String] + + # @!attribute minimum_intervals + # The minimum intervals for this subscription sorted by the start_date. + # + # @return [Array] + required :minimum_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval] } + + # @!attribute net_terms + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. + # + # @return [Integer] + required :net_terms, Integer + + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange }, + nil?: true + + # @!attribute plan + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). + # + # @return [Orb::Models::Plan] + required :plan, -> { Orb::Models::Plan } + + # @!attribute price_intervals + # The price intervals for this subscription. + # + # @return [Array] + required :price_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval] } + + # @!attribute redeemed_coupon + # + # @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon, nil] + required :redeemed_coupon, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon }, + nil?: true + + # @!attribute start_date + # The date Orb starts billing for this subscription. + # + # @return [Time] + required :start_date, Time + + # @!attribute status + # + # @return [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status] + required :status, enum: -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status } + + # @!attribute trial_info + # + # @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo] + required :trial_info, -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo } + + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources }, + nil?: true + + # @!parse + # # @param id [String] + # # @param active_plan_phase_order [Integer, nil] + # # @param adjustment_intervals [Array] + # # @param auto_collection [Boolean, nil] + # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration] + # # @param billing_cycle_day [Integer] + # # @param created_at [Time] + # # @param current_billing_period_end_date [Time, nil] + # # @param current_billing_period_start_date [Time, nil] + # # @param customer [Orb::Models::Customer] + # # @param default_invoice_memo [String, nil] + # # @param discount_intervals [Array] + # # @param end_date [Time, nil] + # # @param fixed_fee_quantity_schedule [Array] + # # @param invoicing_threshold [String, nil] + # # @param maximum_intervals [Array] + # # @param metadata [Hash{Symbol=>String}] + # # @param minimum_intervals [Array] + # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange, nil] + # # @param plan [Orb::Models::Plan] + # # @param price_intervals [Array] + # # @param redeemed_coupon [Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon, nil] + # # @param start_date [Time] + # # @param status [Symbol, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status] + # # @param trial_info [Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources, nil] + # # + # def initialize( + # id:, + # active_plan_phase_order:, + # adjustment_intervals:, + # auto_collection:, + # billing_cycle_anchor_configuration:, + # billing_cycle_day:, + # created_at:, + # current_billing_period_end_date:, + # current_billing_period_start_date:, + # customer:, + # default_invoice_memo:, + # discount_intervals:, + # end_date:, + # fixed_fee_quantity_schedule:, + # invoicing_threshold:, + # maximum_intervals:, + # metadata:, + # minimum_intervals:, + # net_terms:, + # pending_subscription_change:, + # plan:, + # price_intervals:, + # redeemed_coupon:, + # start_date:, + # status:, + # trial_info:, + # changed_resources: nil, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + class AdjustmentInterval < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment + # + # @return [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + required :adjustment, + union: -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment } + + # @!attribute applies_to_price_interval_ids + # The price interval IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute end_date + # The end date of the adjustment interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # The start date of the adjustment interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param id [String] + # # @param adjustment [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # + # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval#adjustment + module Adjustment + extend Orb::Internal::Type::Union + + discriminator :adjustment_type + + variant :usage_discount, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment } + + variant :amount_discount, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment } + + variant :percentage_discount, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment } + + variant :minimum, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment } + + variant :maximum, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } + + class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :usage_discount] + required :adjustment_type, const: :usage_discount + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!attribute usage_discount + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. + # + # @return [Float] + required :usage_discount, Float + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param usage_discount [Float] + # # @param adjustment_type [Symbol, :usage_discount] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # plan_phase_order:, + # reason:, + # usage_discount:, + # adjustment_type: :usage_discount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :amount_discount] + required :adjustment_type, const: :amount_discount + + # @!attribute amount_discount + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. + # + # @return [String] + required :amount_discount, String + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param amount_discount [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :amount_discount] + # # + # def initialize( + # id:, + # amount_discount:, + # applies_to_price_ids:, + # is_invoice_level:, + # plan_phase_order:, + # reason:, + # adjustment_type: :amount_discount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :percentage_discount] + required :adjustment_type, const: :percentage_discount + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute percentage_discount + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. + # + # @return [Float] + required :percentage_discount, Float + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param percentage_discount [Float] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :percentage_discount] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # percentage_discount:, + # plan_phase_order:, + # reason:, + # adjustment_type: :percentage_discount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :minimum] + required :adjustment_type, const: :minimum + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute item_id + # The item ID that revenue from this minimum will be attributed to. + # + # @return [String] + required :item_id, String + + # @!attribute minimum_amount + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. + # + # @return [String] + required :minimum_amount, String + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param item_id [String] + # # @param minimum_amount [String] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :minimum] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # item_id:, + # minimum_amount:, + # plan_phase_order:, + # reason:, + # adjustment_type: :minimum, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :maximum] + required :adjustment_type, const: :maximum + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute maximum_amount + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. + # + # @return [String] + required :maximum_amount, String + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param maximum_amount [String] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :maximum] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # maximum_amount:, + # plan_phase_order:, + # reason:, + # adjustment_type: :maximum, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @!parse + # # @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] + # def self.variants; end + end + end + + # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#billing_cycle_anchor_configuration + class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel + # @!attribute day + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + # + # @return [Integer] + required :day, Integer + + # @!attribute month + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + # + # @return [Integer, nil] + optional :month, Integer, nil?: true + + # @!attribute year + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # + # @return [Integer, nil] + optional :year, Integer, nil?: true + + # @!parse + # # @param day [Integer] + # # @param month [Integer, nil] + # # @param year [Integer, nil] + # # + # def initialize(day:, month: nil, year: nil, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + module DiscountInterval + extend Orb::Internal::Type::Union + + discriminator :discount_type + + variant :amount, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval } + + variant :percentage, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval } + + variant :usage, + -> { Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval } + + class AmountDiscountInterval < Orb::Internal::Type::BaseModel + # @!attribute amount_discount + # Only available if discount_type is `amount`. + # + # @return [String] + required :amount_discount, String + + # @!attribute applies_to_price_ids + # The price ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute discount_type + # + # @return [Symbol, :amount] + required :discount_type, const: :amount + + # @!attribute end_date + # The end date of the discount interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # The start date of the discount interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param amount_discount [String] + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # @param discount_type [Symbol, :amount] + # # + # def initialize( + # amount_discount:, + # applies_to_price_ids:, + # applies_to_price_interval_ids:, + # end_date:, + # start_date:, + # discount_type: :amount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PercentageDiscountInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute discount_type + # + # @return [Symbol, :percentage] + required :discount_type, const: :percentage + + # @!attribute end_date + # The end date of the discount interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute percentage_discount + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. + # + # @return [Float] + required :percentage_discount, Float + + # @!attribute start_date + # The start date of the discount interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param percentage_discount [Float] + # # @param start_date [Time] + # # @param discount_type [Symbol, :percentage] + # # + # def initialize( + # applies_to_price_ids:, + # applies_to_price_interval_ids:, + # end_date:, + # percentage_discount:, + # start_date:, + # discount_type: :percentage, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class UsageDiscountInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute discount_type + # + # @return [Symbol, :usage] + required :discount_type, const: :usage + + # @!attribute end_date + # The end date of the discount interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # The start date of the discount interval. + # + # @return [Time] + required :start_date, Time + + # @!attribute usage_discount + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + # + # @return [Float] + required :usage_discount, Float + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # @param usage_discount [Float] + # # @param discount_type [Symbol, :usage] + # # + # def initialize( + # applies_to_price_ids:, + # applies_to_price_interval_ids:, + # end_date:, + # start_date:, + # usage_discount:, + # discount_type: :usage, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @!parse + # # @return [Array(Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval)] + # def self.variants; end + end + + class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel + # @!attribute end_date + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute price_id + # + # @return [String] + required :price_id, String + + # @!attribute quantity + # + # @return [Float] + required :quantity, Float + + # @!attribute start_date + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param end_date [Time, nil] + # # @param price_id [String] + # # @param quantity [Float] + # # @param start_date [Time] + # # + # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class MaximumInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this maximum interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this maximum interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute end_date + # The end date of the maximum interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute maximum_amount + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. + # + # @return [String] + required :maximum_amount, String + + # @!attribute start_date + # The start date of the maximum interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param maximum_amount [String] + # # @param start_date [Time] + # # + # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class MinimumInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this minimum interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this minimum interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute end_date + # The end date of the minimum interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute minimum_amount + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. + # + # @return [String] + required :minimum_amount, String + + # @!attribute start_date + # The start date of the minimum interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param minimum_amount [String] + # # @param start_date [Time] + # # + # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PriceInterval < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute billing_cycle_day + # The day of the month that Orb bills for this price + # + # @return [Integer] + required :billing_cycle_day, Integer + + # @!attribute current_billing_period_end_date + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. + # + # @return [Time, nil] + required :current_billing_period_end_date, Time, nil?: true + + # @!attribute current_billing_period_start_date + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. + # + # @return [Time, nil] + required :current_billing_period_start_date, Time, nil?: true + + # @!attribute end_date + # The end date of the price interval. This is the date that Orb stops billing for + # this price. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute filter + # An additional filter to apply to usage queries. + # + # @return [String, nil] + required :filter, String, nil?: true + + # @!attribute fixed_fee_quantity_transitions + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. + # + # @return [Array, nil] + required :fixed_fee_quantity_transitions, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] }, + nil?: true + + # @!attribute price + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) + # + # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] + required :price, union: -> { Orb::Models::Price } + + # @!attribute start_date + # The start date of the price interval. This is the date that Orb starts billing + # for this price. + # + # @return [Time] + required :start_date, Time + + # @!attribute usage_customer_ids + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. + # + # @return [Array, nil] + required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true + + # @!parse + # # The Price Interval resource represents a period of time for which a price will + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. + # # + # # @param id [String] + # # @param billing_cycle_day [Integer] + # # @param current_billing_period_end_date [Time, nil] + # # @param current_billing_period_start_date [Time, nil] + # # @param end_date [Time, nil] + # # @param filter [String, nil] + # # @param fixed_fee_quantity_transitions [Array, nil] + # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] + # # @param start_date [Time] + # # @param usage_customer_ids [Array, nil] + # # + # def initialize( + # id:, + # billing_cycle_day:, + # current_billing_period_end_date:, + # current_billing_period_start_date:, + # end_date:, + # filter:, + # fixed_fee_quantity_transitions:, + # price:, + # start_date:, + # usage_customer_ids:, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel + # @!attribute effective_date + # + # @return [Time] + required :effective_date, Time + + # @!attribute price_id + # + # @return [String] + required :price_id, String + + # @!attribute quantity + # + # @return [Integer] + required :quantity, Integer + + # @!parse + # # @param effective_date [Time] + # # @param price_id [String] + # # @param quantity [Integer] + # # + # def initialize(effective_date:, price_id:, quantity:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + end + + # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#redeemed_coupon + class RedeemedCoupon < Orb::Internal::Type::BaseModel + # @!attribute coupon_id + # + # @return [String] + required :coupon_id, String + + # @!attribute end_date + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param coupon_id [String] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # + # def initialize(coupon_id:, end_date:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#status + module Status + extend Orb::Internal::Type::Enum + + ACTIVE = :active + ENDED = :ended + UPCOMING = :upcoming + + finalize! + + # @!parse + # # @return [Array] + # def self.values; end + end + + # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#trial_info + class TrialInfo < Orb::Internal::Type::BaseModel + # @!attribute end_date + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!parse + # # @param end_date [Time, nil] + # # + # def initialize(end_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @see Orb::Models::SubscriptionChangeApplyResponse::Subscription#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + end + end + end +end diff --git a/lib/orb/models/subscription_change_cancel_params.rb b/lib/orb/models/subscription_change_cancel_params.rb new file mode 100644 index 00000000..44e39d1b --- /dev/null +++ b/lib/orb/models/subscription_change_cancel_params.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +module Orb + module Models + # @see Orb::Resources::SubscriptionChanges#cancel + class SubscriptionChangeCancelParams < Orb::Internal::Type::BaseModel + # @!parse + # extend Orb::Internal::Type::RequestParameters::Converter + include Orb::Internal::Type::RequestParameters + + # @!parse + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] + # # + # def initialize(request_options: {}, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + end +end diff --git a/lib/orb/models/subscription_change_cancel_response.rb b/lib/orb/models/subscription_change_cancel_response.rb new file mode 100644 index 00000000..44f64e33 --- /dev/null +++ b/lib/orb/models/subscription_change_cancel_response.rb @@ -0,0 +1,1372 @@ +# frozen_string_literal: true + +module Orb + module Models + # @see Orb::Resources::SubscriptionChanges#cancel + class SubscriptionChangeCancelResponse < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute expiration_time + # Subscription change will be cancelled at this time and can no longer be applied. + # + # @return [Time] + required :expiration_time, Time + + # @!attribute status + # + # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Status] + required :status, enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Status } + + # @!attribute subscription + # + # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription, nil] + required :subscription, -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription }, nil?: true + + # @!attribute applied_at + # When this change was applied. + # + # @return [Time, nil] + optional :applied_at, Time, nil?: true + + # @!attribute cancelled_at + # When this change was cancelled. + # + # @return [Time, nil] + optional :cancelled_at, Time, nil?: true + + # @!parse + # # A subscription change represents a desired new subscription / pending change to + # # an existing subscription. It is a way to first preview the effects on the + # # subscription as well as any changes/creation of invoices (see + # # `subscription.changed_resources`). + # # + # # @param id [String] + # # @param expiration_time [Time] + # # @param status [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Status] + # # @param subscription [Orb::Models::SubscriptionChangeCancelResponse::Subscription, nil] + # # @param applied_at [Time, nil] + # # @param cancelled_at [Time, nil] + # # + # def initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + # @see Orb::Models::SubscriptionChangeCancelResponse#status + module Status + extend Orb::Internal::Type::Enum + + PENDING = :pending + APPLIED = :applied + CANCELLED = :cancelled + + finalize! + + # @!parse + # # @return [Array] + # def self.values; end + end + + # @see Orb::Models::SubscriptionChangeCancelResponse#subscription + class Subscription < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute active_plan_phase_order + # The current plan phase that is active, only if the subscription's plan has + # phases. + # + # @return [Integer, nil] + required :active_plan_phase_order, Integer, nil?: true + + # @!attribute adjustment_intervals + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. + # + # @return [Array] + required :adjustment_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval] } + + # @!attribute auto_collection + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. + # + # @return [Boolean, nil] + required :auto_collection, Orb::Internal::Type::Boolean, nil?: true + + # @!attribute billing_cycle_anchor_configuration + # + # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration] + required :billing_cycle_anchor_configuration, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration } + + # @!attribute billing_cycle_day + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + # + # @return [Integer] + required :billing_cycle_day, Integer + + # @!attribute created_at + # + # @return [Time] + required :created_at, Time + + # @!attribute current_billing_period_end_date + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. + # + # @return [Time, nil] + required :current_billing_period_end_date, Time, nil?: true + + # @!attribute current_billing_period_start_date + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. + # + # @return [Time, nil] + required :current_billing_period_start_date, Time, nil?: true + + # @!attribute customer + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. + # + # @return [Orb::Models::Customer] + required :customer, -> { Orb::Models::Customer } + + # @!attribute default_invoice_memo + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. + # + # @return [String, nil] + required :default_invoice_memo, String, nil?: true + + # @!attribute discount_intervals + # The discount intervals for this subscription sorted by the start_date. + # + # @return [Array] + required :discount_intervals, + -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval] } + + # @!attribute end_date + # The date Orb stops billing for this subscription. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute fixed_fee_quantity_schedule + # + # @return [Array] + required :fixed_fee_quantity_schedule, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::FixedFeeQuantitySchedule] } + + # @!attribute invoicing_threshold + # + # @return [String, nil] + required :invoicing_threshold, String, nil?: true + + # @!attribute maximum_intervals + # The maximum intervals for this subscription sorted by the start_date. + # + # @return [Array] + required :maximum_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval] } + + # @!attribute metadata + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. + # + # @return [Hash{Symbol=>String}] + required :metadata, Orb::Internal::Type::HashOf[String] + + # @!attribute minimum_intervals + # The minimum intervals for this subscription sorted by the start_date. + # + # @return [Array] + required :minimum_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval] } + + # @!attribute net_terms + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. + # + # @return [Integer] + required :net_terms, Integer + + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange }, + nil?: true + + # @!attribute plan + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). + # + # @return [Orb::Models::Plan] + required :plan, -> { Orb::Models::Plan } + + # @!attribute price_intervals + # The price intervals for this subscription. + # + # @return [Array] + required :price_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval] } + + # @!attribute redeemed_coupon + # + # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon, nil] + required :redeemed_coupon, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon }, + nil?: true + + # @!attribute start_date + # The date Orb starts billing for this subscription. + # + # @return [Time] + required :start_date, Time + + # @!attribute status + # + # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status] + required :status, enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status } + + # @!attribute trial_info + # + # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo] + required :trial_info, -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo } + + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources }, + nil?: true + + # @!parse + # # @param id [String] + # # @param active_plan_phase_order [Integer, nil] + # # @param adjustment_intervals [Array] + # # @param auto_collection [Boolean, nil] + # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration] + # # @param billing_cycle_day [Integer] + # # @param created_at [Time] + # # @param current_billing_period_end_date [Time, nil] + # # @param current_billing_period_start_date [Time, nil] + # # @param customer [Orb::Models::Customer] + # # @param default_invoice_memo [String, nil] + # # @param discount_intervals [Array] + # # @param end_date [Time, nil] + # # @param fixed_fee_quantity_schedule [Array] + # # @param invoicing_threshold [String, nil] + # # @param maximum_intervals [Array] + # # @param metadata [Hash{Symbol=>String}] + # # @param minimum_intervals [Array] + # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange, nil] + # # @param plan [Orb::Models::Plan] + # # @param price_intervals [Array] + # # @param redeemed_coupon [Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon, nil] + # # @param start_date [Time] + # # @param status [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status] + # # @param trial_info [Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources, nil] + # # + # def initialize( + # id:, + # active_plan_phase_order:, + # adjustment_intervals:, + # auto_collection:, + # billing_cycle_anchor_configuration:, + # billing_cycle_day:, + # created_at:, + # current_billing_period_end_date:, + # current_billing_period_start_date:, + # customer:, + # default_invoice_memo:, + # discount_intervals:, + # end_date:, + # fixed_fee_quantity_schedule:, + # invoicing_threshold:, + # maximum_intervals:, + # metadata:, + # minimum_intervals:, + # net_terms:, + # pending_subscription_change:, + # plan:, + # price_intervals:, + # redeemed_coupon:, + # start_date:, + # status:, + # trial_info:, + # changed_resources: nil, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + class AdjustmentInterval < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment + # + # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + required :adjustment, + union: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment } + + # @!attribute applies_to_price_interval_ids + # The price interval IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute end_date + # The end date of the adjustment interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # The start date of the adjustment interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param id [String] + # # @param adjustment [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # + # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval#adjustment + module Adjustment + extend Orb::Internal::Type::Union + + discriminator :adjustment_type + + variant :usage_discount, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment } + + variant :amount_discount, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment } + + variant :percentage_discount, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment } + + variant :minimum, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment } + + variant :maximum, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } + + class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :usage_discount] + required :adjustment_type, const: :usage_discount + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!attribute usage_discount + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. + # + # @return [Float] + required :usage_discount, Float + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param usage_discount [Float] + # # @param adjustment_type [Symbol, :usage_discount] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # plan_phase_order:, + # reason:, + # usage_discount:, + # adjustment_type: :usage_discount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :amount_discount] + required :adjustment_type, const: :amount_discount + + # @!attribute amount_discount + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. + # + # @return [String] + required :amount_discount, String + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param amount_discount [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :amount_discount] + # # + # def initialize( + # id:, + # amount_discount:, + # applies_to_price_ids:, + # is_invoice_level:, + # plan_phase_order:, + # reason:, + # adjustment_type: :amount_discount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :percentage_discount] + required :adjustment_type, const: :percentage_discount + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute percentage_discount + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. + # + # @return [Float] + required :percentage_discount, Float + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param percentage_discount [Float] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :percentage_discount] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # percentage_discount:, + # plan_phase_order:, + # reason:, + # adjustment_type: :percentage_discount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :minimum] + required :adjustment_type, const: :minimum + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute item_id + # The item ID that revenue from this minimum will be attributed to. + # + # @return [String] + required :item_id, String + + # @!attribute minimum_amount + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. + # + # @return [String] + required :minimum_amount, String + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param item_id [String] + # # @param minimum_amount [String] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :minimum] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # item_id:, + # minimum_amount:, + # plan_phase_order:, + # reason:, + # adjustment_type: :minimum, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :maximum] + required :adjustment_type, const: :maximum + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute maximum_amount + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. + # + # @return [String] + required :maximum_amount, String + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param maximum_amount [String] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :maximum] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # maximum_amount:, + # plan_phase_order:, + # reason:, + # adjustment_type: :maximum, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @!parse + # # @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] + # def self.variants; end + end + end + + # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#billing_cycle_anchor_configuration + class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel + # @!attribute day + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + # + # @return [Integer] + required :day, Integer + + # @!attribute month + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + # + # @return [Integer, nil] + optional :month, Integer, nil?: true + + # @!attribute year + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # + # @return [Integer, nil] + optional :year, Integer, nil?: true + + # @!parse + # # @param day [Integer] + # # @param month [Integer, nil] + # # @param year [Integer, nil] + # # + # def initialize(day:, month: nil, year: nil, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + module DiscountInterval + extend Orb::Internal::Type::Union + + discriminator :discount_type + + variant :amount, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval } + + variant :percentage, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval } + + variant :usage, + -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval } + + class AmountDiscountInterval < Orb::Internal::Type::BaseModel + # @!attribute amount_discount + # Only available if discount_type is `amount`. + # + # @return [String] + required :amount_discount, String + + # @!attribute applies_to_price_ids + # The price ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute discount_type + # + # @return [Symbol, :amount] + required :discount_type, const: :amount + + # @!attribute end_date + # The end date of the discount interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # The start date of the discount interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param amount_discount [String] + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # @param discount_type [Symbol, :amount] + # # + # def initialize( + # amount_discount:, + # applies_to_price_ids:, + # applies_to_price_interval_ids:, + # end_date:, + # start_date:, + # discount_type: :amount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PercentageDiscountInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute discount_type + # + # @return [Symbol, :percentage] + required :discount_type, const: :percentage + + # @!attribute end_date + # The end date of the discount interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute percentage_discount + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. + # + # @return [Float] + required :percentage_discount, Float + + # @!attribute start_date + # The start date of the discount interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param percentage_discount [Float] + # # @param start_date [Time] + # # @param discount_type [Symbol, :percentage] + # # + # def initialize( + # applies_to_price_ids:, + # applies_to_price_interval_ids:, + # end_date:, + # percentage_discount:, + # start_date:, + # discount_type: :percentage, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class UsageDiscountInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute discount_type + # + # @return [Symbol, :usage] + required :discount_type, const: :usage + + # @!attribute end_date + # The end date of the discount interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # The start date of the discount interval. + # + # @return [Time] + required :start_date, Time + + # @!attribute usage_discount + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + # + # @return [Float] + required :usage_discount, Float + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # @param usage_discount [Float] + # # @param discount_type [Symbol, :usage] + # # + # def initialize( + # applies_to_price_ids:, + # applies_to_price_interval_ids:, + # end_date:, + # start_date:, + # usage_discount:, + # discount_type: :usage, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @!parse + # # @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval)] + # def self.variants; end + end + + class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel + # @!attribute end_date + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute price_id + # + # @return [String] + required :price_id, String + + # @!attribute quantity + # + # @return [Float] + required :quantity, Float + + # @!attribute start_date + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param end_date [Time, nil] + # # @param price_id [String] + # # @param quantity [Float] + # # @param start_date [Time] + # # + # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class MaximumInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this maximum interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this maximum interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute end_date + # The end date of the maximum interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute maximum_amount + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. + # + # @return [String] + required :maximum_amount, String + + # @!attribute start_date + # The start date of the maximum interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param maximum_amount [String] + # # @param start_date [Time] + # # + # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class MinimumInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this minimum interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this minimum interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute end_date + # The end date of the minimum interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute minimum_amount + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. + # + # @return [String] + required :minimum_amount, String + + # @!attribute start_date + # The start date of the minimum interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param minimum_amount [String] + # # @param start_date [Time] + # # + # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PriceInterval < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute billing_cycle_day + # The day of the month that Orb bills for this price + # + # @return [Integer] + required :billing_cycle_day, Integer + + # @!attribute current_billing_period_end_date + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. + # + # @return [Time, nil] + required :current_billing_period_end_date, Time, nil?: true + + # @!attribute current_billing_period_start_date + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. + # + # @return [Time, nil] + required :current_billing_period_start_date, Time, nil?: true + + # @!attribute end_date + # The end date of the price interval. This is the date that Orb stops billing for + # this price. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute filter + # An additional filter to apply to usage queries. + # + # @return [String, nil] + required :filter, String, nil?: true + + # @!attribute fixed_fee_quantity_transitions + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. + # + # @return [Array, nil] + required :fixed_fee_quantity_transitions, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] }, + nil?: true + + # @!attribute price + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) + # + # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] + required :price, union: -> { Orb::Models::Price } + + # @!attribute start_date + # The start date of the price interval. This is the date that Orb starts billing + # for this price. + # + # @return [Time] + required :start_date, Time + + # @!attribute usage_customer_ids + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. + # + # @return [Array, nil] + required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true + + # @!parse + # # The Price Interval resource represents a period of time for which a price will + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. + # # + # # @param id [String] + # # @param billing_cycle_day [Integer] + # # @param current_billing_period_end_date [Time, nil] + # # @param current_billing_period_start_date [Time, nil] + # # @param end_date [Time, nil] + # # @param filter [String, nil] + # # @param fixed_fee_quantity_transitions [Array, nil] + # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] + # # @param start_date [Time] + # # @param usage_customer_ids [Array, nil] + # # + # def initialize( + # id:, + # billing_cycle_day:, + # current_billing_period_end_date:, + # current_billing_period_start_date:, + # end_date:, + # filter:, + # fixed_fee_quantity_transitions:, + # price:, + # start_date:, + # usage_customer_ids:, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel + # @!attribute effective_date + # + # @return [Time] + required :effective_date, Time + + # @!attribute price_id + # + # @return [String] + required :price_id, String + + # @!attribute quantity + # + # @return [Integer] + required :quantity, Integer + + # @!parse + # # @param effective_date [Time] + # # @param price_id [String] + # # @param quantity [Integer] + # # + # def initialize(effective_date:, price_id:, quantity:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + end + + # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#redeemed_coupon + class RedeemedCoupon < Orb::Internal::Type::BaseModel + # @!attribute coupon_id + # + # @return [String] + required :coupon_id, String + + # @!attribute end_date + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param coupon_id [String] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # + # def initialize(coupon_id:, end_date:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#status + module Status + extend Orb::Internal::Type::Enum + + ACTIVE = :active + ENDED = :ended + UPCOMING = :upcoming + + finalize! + + # @!parse + # # @return [Array] + # def self.values; end + end + + # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#trial_info + class TrialInfo < Orb::Internal::Type::BaseModel + # @!attribute end_date + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!parse + # # @param end_date [Time, nil] + # # + # def initialize(end_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + end + end + end +end diff --git a/lib/orb/models/subscription_change_retrieve_params.rb b/lib/orb/models/subscription_change_retrieve_params.rb new file mode 100644 index 00000000..358acf42 --- /dev/null +++ b/lib/orb/models/subscription_change_retrieve_params.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +module Orb + module Models + # @see Orb::Resources::SubscriptionChanges#retrieve + class SubscriptionChangeRetrieveParams < Orb::Internal::Type::BaseModel + # @!parse + # extend Orb::Internal::Type::RequestParameters::Converter + include Orb::Internal::Type::RequestParameters + + # @!parse + # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] + # # + # def initialize(request_options: {}, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + end +end diff --git a/lib/orb/models/subscription_change_retrieve_response.rb b/lib/orb/models/subscription_change_retrieve_response.rb new file mode 100644 index 00000000..572e8c8d --- /dev/null +++ b/lib/orb/models/subscription_change_retrieve_response.rb @@ -0,0 +1,1372 @@ +# frozen_string_literal: true + +module Orb + module Models + # @see Orb::Resources::SubscriptionChanges#retrieve + class SubscriptionChangeRetrieveResponse < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute expiration_time + # Subscription change will be cancelled at this time and can no longer be applied. + # + # @return [Time] + required :expiration_time, Time + + # @!attribute status + # + # @return [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status] + required :status, enum: -> { Orb::Models::SubscriptionChangeRetrieveResponse::Status } + + # @!attribute subscription + # + # @return [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription, nil] + required :subscription, -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription }, nil?: true + + # @!attribute applied_at + # When this change was applied. + # + # @return [Time, nil] + optional :applied_at, Time, nil?: true + + # @!attribute cancelled_at + # When this change was cancelled. + # + # @return [Time, nil] + optional :cancelled_at, Time, nil?: true + + # @!parse + # # A subscription change represents a desired new subscription / pending change to + # # an existing subscription. It is a way to first preview the effects on the + # # subscription as well as any changes/creation of invoices (see + # # `subscription.changed_resources`). + # # + # # @param id [String] + # # @param expiration_time [Time] + # # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status] + # # @param subscription [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription, nil] + # # @param applied_at [Time, nil] + # # @param cancelled_at [Time, nil] + # # + # def initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + # @see Orb::Models::SubscriptionChangeRetrieveResponse#status + module Status + extend Orb::Internal::Type::Enum + + PENDING = :pending + APPLIED = :applied + CANCELLED = :cancelled + + finalize! + + # @!parse + # # @return [Array] + # def self.values; end + end + + # @see Orb::Models::SubscriptionChangeRetrieveResponse#subscription + class Subscription < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute active_plan_phase_order + # The current plan phase that is active, only if the subscription's plan has + # phases. + # + # @return [Integer, nil] + required :active_plan_phase_order, Integer, nil?: true + + # @!attribute adjustment_intervals + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. + # + # @return [Array] + required :adjustment_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval] } + + # @!attribute auto_collection + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. + # + # @return [Boolean, nil] + required :auto_collection, Orb::Internal::Type::Boolean, nil?: true + + # @!attribute billing_cycle_anchor_configuration + # + # @return [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration] + required :billing_cycle_anchor_configuration, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration } + + # @!attribute billing_cycle_day + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + # + # @return [Integer] + required :billing_cycle_day, Integer + + # @!attribute created_at + # + # @return [Time] + required :created_at, Time + + # @!attribute current_billing_period_end_date + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. + # + # @return [Time, nil] + required :current_billing_period_end_date, Time, nil?: true + + # @!attribute current_billing_period_start_date + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. + # + # @return [Time, nil] + required :current_billing_period_start_date, Time, nil?: true + + # @!attribute customer + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. + # + # @return [Orb::Models::Customer] + required :customer, -> { Orb::Models::Customer } + + # @!attribute default_invoice_memo + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. + # + # @return [String, nil] + required :default_invoice_memo, String, nil?: true + + # @!attribute discount_intervals + # The discount intervals for this subscription sorted by the start_date. + # + # @return [Array] + required :discount_intervals, + -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval] } + + # @!attribute end_date + # The date Orb stops billing for this subscription. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute fixed_fee_quantity_schedule + # + # @return [Array] + required :fixed_fee_quantity_schedule, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule] } + + # @!attribute invoicing_threshold + # + # @return [String, nil] + required :invoicing_threshold, String, nil?: true + + # @!attribute maximum_intervals + # The maximum intervals for this subscription sorted by the start_date. + # + # @return [Array] + required :maximum_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval] } + + # @!attribute metadata + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. + # + # @return [Hash{Symbol=>String}] + required :metadata, Orb::Internal::Type::HashOf[String] + + # @!attribute minimum_intervals + # The minimum intervals for this subscription sorted by the start_date. + # + # @return [Array] + required :minimum_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval] } + + # @!attribute net_terms + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. + # + # @return [Integer] + required :net_terms, Integer + + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange }, + nil?: true + + # @!attribute plan + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). + # + # @return [Orb::Models::Plan] + required :plan, -> { Orb::Models::Plan } + + # @!attribute price_intervals + # The price intervals for this subscription. + # + # @return [Array] + required :price_intervals, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval] } + + # @!attribute redeemed_coupon + # + # @return [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon, nil] + required :redeemed_coupon, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon }, + nil?: true + + # @!attribute start_date + # The date Orb starts billing for this subscription. + # + # @return [Time] + required :start_date, Time + + # @!attribute status + # + # @return [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status] + required :status, enum: -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status } + + # @!attribute trial_info + # + # @return [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo] + required :trial_info, -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo } + + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources }, + nil?: true + + # @!parse + # # @param id [String] + # # @param active_plan_phase_order [Integer, nil] + # # @param adjustment_intervals [Array] + # # @param auto_collection [Boolean, nil] + # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration] + # # @param billing_cycle_day [Integer] + # # @param created_at [Time] + # # @param current_billing_period_end_date [Time, nil] + # # @param current_billing_period_start_date [Time, nil] + # # @param customer [Orb::Models::Customer] + # # @param default_invoice_memo [String, nil] + # # @param discount_intervals [Array] + # # @param end_date [Time, nil] + # # @param fixed_fee_quantity_schedule [Array] + # # @param invoicing_threshold [String, nil] + # # @param maximum_intervals [Array] + # # @param metadata [Hash{Symbol=>String}] + # # @param minimum_intervals [Array] + # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange, nil] + # # @param plan [Orb::Models::Plan] + # # @param price_intervals [Array] + # # @param redeemed_coupon [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon, nil] + # # @param start_date [Time] + # # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status] + # # @param trial_info [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources, nil] + # # + # def initialize( + # id:, + # active_plan_phase_order:, + # adjustment_intervals:, + # auto_collection:, + # billing_cycle_anchor_configuration:, + # billing_cycle_day:, + # created_at:, + # current_billing_period_end_date:, + # current_billing_period_start_date:, + # customer:, + # default_invoice_memo:, + # discount_intervals:, + # end_date:, + # fixed_fee_quantity_schedule:, + # invoicing_threshold:, + # maximum_intervals:, + # metadata:, + # minimum_intervals:, + # net_terms:, + # pending_subscription_change:, + # plan:, + # price_intervals:, + # redeemed_coupon:, + # start_date:, + # status:, + # trial_info:, + # changed_resources: nil, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + class AdjustmentInterval < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment + # + # @return [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + required :adjustment, + union: -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment } + + # @!attribute applies_to_price_interval_ids + # The price interval IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute end_date + # The end date of the adjustment interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # The start date of the adjustment interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param id [String] + # # @param adjustment [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # + # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval#adjustment + module Adjustment + extend Orb::Internal::Type::Union + + discriminator :adjustment_type + + variant :usage_discount, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment } + + variant :amount_discount, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment } + + variant :percentage_discount, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment } + + variant :minimum, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment } + + variant :maximum, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment } + + class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :usage_discount] + required :adjustment_type, const: :usage_discount + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!attribute usage_discount + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. + # + # @return [Float] + required :usage_discount, Float + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param usage_discount [Float] + # # @param adjustment_type [Symbol, :usage_discount] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # plan_phase_order:, + # reason:, + # usage_discount:, + # adjustment_type: :usage_discount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :amount_discount] + required :adjustment_type, const: :amount_discount + + # @!attribute amount_discount + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. + # + # @return [String] + required :amount_discount, String + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param amount_discount [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :amount_discount] + # # + # def initialize( + # id:, + # amount_discount:, + # applies_to_price_ids:, + # is_invoice_level:, + # plan_phase_order:, + # reason:, + # adjustment_type: :amount_discount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :percentage_discount] + required :adjustment_type, const: :percentage_discount + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute percentage_discount + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. + # + # @return [Float] + required :percentage_discount, Float + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param percentage_discount [Float] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :percentage_discount] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # percentage_discount:, + # plan_phase_order:, + # reason:, + # adjustment_type: :percentage_discount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :minimum] + required :adjustment_type, const: :minimum + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute item_id + # The item ID that revenue from this minimum will be attributed to. + # + # @return [String] + required :item_id, String + + # @!attribute minimum_amount + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. + # + # @return [String] + required :minimum_amount, String + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param item_id [String] + # # @param minimum_amount [String] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :minimum] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # item_id:, + # minimum_amount:, + # plan_phase_order:, + # reason:, + # adjustment_type: :minimum, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute adjustment_type + # + # @return [Symbol, :maximum] + required :adjustment_type, const: :maximum + + # @!attribute applies_to_price_ids + # The price IDs that this adjustment applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute is_invoice_level + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + # + # @return [Boolean] + required :is_invoice_level, Orb::Internal::Type::Boolean + + # @!attribute maximum_amount + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. + # + # @return [String] + required :maximum_amount, String + + # @!attribute plan_phase_order + # The plan phase in which this adjustment is active. + # + # @return [Integer, nil] + required :plan_phase_order, Integer, nil?: true + + # @!attribute reason + # The reason for the adjustment. + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!parse + # # @param id [String] + # # @param applies_to_price_ids [Array] + # # @param is_invoice_level [Boolean] + # # @param maximum_amount [String] + # # @param plan_phase_order [Integer, nil] + # # @param reason [String, nil] + # # @param adjustment_type [Symbol, :maximum] + # # + # def initialize( + # id:, + # applies_to_price_ids:, + # is_invoice_level:, + # maximum_amount:, + # plan_phase_order:, + # reason:, + # adjustment_type: :maximum, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @!parse + # # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)] + # def self.variants; end + end + end + + # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#billing_cycle_anchor_configuration + class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel + # @!attribute day + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + # + # @return [Integer] + required :day, Integer + + # @!attribute month + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + # + # @return [Integer, nil] + optional :month, Integer, nil?: true + + # @!attribute year + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + # + # @return [Integer, nil] + optional :year, Integer, nil?: true + + # @!parse + # # @param day [Integer] + # # @param month [Integer, nil] + # # @param year [Integer, nil] + # # + # def initialize(day:, month: nil, year: nil, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + module DiscountInterval + extend Orb::Internal::Type::Union + + discriminator :discount_type + + variant :amount, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval } + + variant :percentage, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval } + + variant :usage, + -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval } + + class AmountDiscountInterval < Orb::Internal::Type::BaseModel + # @!attribute amount_discount + # Only available if discount_type is `amount`. + # + # @return [String] + required :amount_discount, String + + # @!attribute applies_to_price_ids + # The price ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute discount_type + # + # @return [Symbol, :amount] + required :discount_type, const: :amount + + # @!attribute end_date + # The end date of the discount interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # The start date of the discount interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param amount_discount [String] + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # @param discount_type [Symbol, :amount] + # # + # def initialize( + # amount_discount:, + # applies_to_price_ids:, + # applies_to_price_interval_ids:, + # end_date:, + # start_date:, + # discount_type: :amount, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PercentageDiscountInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute discount_type + # + # @return [Symbol, :percentage] + required :discount_type, const: :percentage + + # @!attribute end_date + # The end date of the discount interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute percentage_discount + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. + # + # @return [Float] + required :percentage_discount, Float + + # @!attribute start_date + # The start date of the discount interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param percentage_discount [Float] + # # @param start_date [Time] + # # @param discount_type [Symbol, :percentage] + # # + # def initialize( + # applies_to_price_ids:, + # applies_to_price_interval_ids:, + # end_date:, + # percentage_discount:, + # start_date:, + # discount_type: :percentage, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class UsageDiscountInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this discount interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute discount_type + # + # @return [Symbol, :usage] + required :discount_type, const: :usage + + # @!attribute end_date + # The end date of the discount interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # The start date of the discount interval. + # + # @return [Time] + required :start_date, Time + + # @!attribute usage_discount + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + # + # @return [Float] + required :usage_discount, Float + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # @param usage_discount [Float] + # # @param discount_type [Symbol, :usage] + # # + # def initialize( + # applies_to_price_ids:, + # applies_to_price_interval_ids:, + # end_date:, + # start_date:, + # usage_discount:, + # discount_type: :usage, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @!parse + # # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval)] + # def self.variants; end + end + + class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel + # @!attribute end_date + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute price_id + # + # @return [String] + required :price_id, String + + # @!attribute quantity + # + # @return [Float] + required :quantity, Float + + # @!attribute start_date + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param end_date [Time, nil] + # # @param price_id [String] + # # @param quantity [Float] + # # @param start_date [Time] + # # + # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class MaximumInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this maximum interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this maximum interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute end_date + # The end date of the maximum interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute maximum_amount + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. + # + # @return [String] + required :maximum_amount, String + + # @!attribute start_date + # The start date of the maximum interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param maximum_amount [String] + # # @param start_date [Time] + # # + # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class MinimumInterval < Orb::Internal::Type::BaseModel + # @!attribute applies_to_price_ids + # The price ids that this minimum interval applies to. + # + # @return [Array] + required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute applies_to_price_interval_ids + # The price interval ids that this minimum interval applies to. + # + # @return [Array] + required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String] + + # @!attribute end_date + # The end date of the minimum interval. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute minimum_amount + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. + # + # @return [String] + required :minimum_amount, String + + # @!attribute start_date + # The start date of the minimum interval. + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param applies_to_price_ids [Array] + # # @param applies_to_price_interval_ids [Array] + # # @param end_date [Time, nil] + # # @param minimum_amount [String] + # # @param start_date [Time] + # # + # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + class PriceInterval < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!attribute billing_cycle_day + # The day of the month that Orb bills for this price + # + # @return [Integer] + required :billing_cycle_day, Integer + + # @!attribute current_billing_period_end_date + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. + # + # @return [Time, nil] + required :current_billing_period_end_date, Time, nil?: true + + # @!attribute current_billing_period_start_date + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. + # + # @return [Time, nil] + required :current_billing_period_start_date, Time, nil?: true + + # @!attribute end_date + # The end date of the price interval. This is the date that Orb stops billing for + # this price. + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute filter + # An additional filter to apply to usage queries. + # + # @return [String, nil] + required :filter, String, nil?: true + + # @!attribute fixed_fee_quantity_transitions + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. + # + # @return [Array, nil] + required :fixed_fee_quantity_transitions, + -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] }, + nil?: true + + # @!attribute price + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) + # + # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] + required :price, union: -> { Orb::Models::Price } + + # @!attribute start_date + # The start date of the price interval. This is the date that Orb starts billing + # for this price. + # + # @return [Time] + required :start_date, Time + + # @!attribute usage_customer_ids + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. + # + # @return [Array, nil] + required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true + + # @!parse + # # The Price Interval resource represents a period of time for which a price will + # # bill on a subscription. A subscription’s price intervals define its billing + # # behavior. + # # + # # @param id [String] + # # @param billing_cycle_day [Integer] + # # @param current_billing_period_end_date [Time, nil] + # # @param current_billing_period_start_date [Time, nil] + # # @param end_date [Time, nil] + # # @param filter [String, nil] + # # @param fixed_fee_quantity_transitions [Array, nil] + # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] + # # @param start_date [Time] + # # @param usage_customer_ids [Array, nil] + # # + # def initialize( + # id:, + # billing_cycle_day:, + # current_billing_period_end_date:, + # current_billing_period_start_date:, + # end_date:, + # filter:, + # fixed_fee_quantity_transitions:, + # price:, + # start_date:, + # usage_customer_ids:, + # ** + # ) + # super + # end + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + + class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel + # @!attribute effective_date + # + # @return [Time] + required :effective_date, Time + + # @!attribute price_id + # + # @return [String] + required :price_id, String + + # @!attribute quantity + # + # @return [Integer] + required :quantity, Integer + + # @!parse + # # @param effective_date [Time] + # # @param price_id [String] + # # @param quantity [Integer] + # # + # def initialize(effective_date:, price_id:, quantity:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + end + + # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#redeemed_coupon + class RedeemedCoupon < Orb::Internal::Type::BaseModel + # @!attribute coupon_id + # + # @return [String] + required :coupon_id, String + + # @!attribute end_date + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!attribute start_date + # + # @return [Time] + required :start_date, Time + + # @!parse + # # @param coupon_id [String] + # # @param end_date [Time, nil] + # # @param start_date [Time] + # # + # def initialize(coupon_id:, end_date:, start_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#status + module Status + extend Orb::Internal::Type::Enum + + ACTIVE = :active + ENDED = :ended + UPCOMING = :upcoming + + finalize! + + # @!parse + # # @return [Array] + # def self.values; end + end + + # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#trial_info + class TrialInfo < Orb::Internal::Type::BaseModel + # @!attribute end_date + # + # @return [Time, nil] + required :end_date, Time, nil?: true + + # @!parse + # # @param end_date [Time, nil] + # # + # def initialize(end_date:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + + # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + end + end + end +end diff --git a/lib/orb/models/subscription_create_params.rb b/lib/orb/models/subscription_create_params.rb index a19498a4..1d8483ee 100644 --- a/lib/orb/models/subscription_create_params.rb +++ b/lib/orb/models/subscription_create_params.rb @@ -1943,7 +1943,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit - # Inclusive tier starting value + # Exclusive tier starting value # # @return [Float] required :first_unit, Float @@ -1955,7 +1955,7 @@ class Tier < Orb::Internal::Type::BaseModel required :unit_amount, String # @!attribute last_unit - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier # # @return [Float, nil] optional :last_unit, Float, nil?: true @@ -2259,13 +2259,13 @@ class Tier < Orb::Internal::Type::BaseModel required :bps, Float # @!attribute minimum_amount - # Inclusive tier starting value + # Exclusive tier starting value # # @return [String] required :minimum_amount, String # @!attribute maximum_amount - # Exclusive tier ending value + # Inclusive tier ending value # # @return [String, nil] optional :maximum_amount, String, nil?: true @@ -9357,7 +9357,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit - # Inclusive tier starting value + # Exclusive tier starting value # # @return [Float] required :first_unit, Float @@ -9369,7 +9369,7 @@ class Tier < Orb::Internal::Type::BaseModel required :unit_amount, String # @!attribute last_unit - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier # # @return [Float, nil] optional :last_unit, Float, nil?: true @@ -9673,13 +9673,13 @@ class Tier < Orb::Internal::Type::BaseModel required :bps, Float # @!attribute minimum_amount - # Inclusive tier starting value + # Exclusive tier starting value # # @return [String] required :minimum_amount, String # @!attribute maximum_amount - # Exclusive tier ending value + # Inclusive tier ending value # # @return [String, nil] optional :maximum_amount, String, nil?: true diff --git a/lib/orb/models/subscription_create_response.rb b/lib/orb/models/subscription_create_response.rb index cf85cc14..31036f2a 100644 --- a/lib/orb/models/subscription_create_response.rb +++ b/lib/orb/models/subscription_create_response.rb @@ -154,6 +154,14 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -191,6 +199,14 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # @return [Orb::Models::SubscriptionCreateResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionCreateResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionCreateResponse::ChangedResources, nil] + optional :changed_resources, -> { Orb::Models::SubscriptionCreateResponse::ChangedResources }, nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -211,12 +227,14 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionCreateResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionCreateResponse::Status] # # @param trial_info [Orb::Models::SubscriptionCreateResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionCreateResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -238,12 +256,14 @@ class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1019,6 +1039,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionCreateResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1215,6 +1252,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionCreateResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/models/subscription_price_intervals_params.rb b/lib/orb/models/subscription_price_intervals_params.rb index 9a6adb8f..a9be5318 100644 --- a/lib/orb/models/subscription_price_intervals_params.rb +++ b/lib/orb/models/subscription_price_intervals_params.rb @@ -1833,7 +1833,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit - # Inclusive tier starting value + # Exclusive tier starting value # # @return [Float] required :first_unit, Float @@ -1845,7 +1845,7 @@ class Tier < Orb::Internal::Type::BaseModel required :unit_amount, String # @!attribute last_unit - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier # # @return [Float, nil] optional :last_unit, Float, nil?: true @@ -2139,13 +2139,13 @@ class Tier < Orb::Internal::Type::BaseModel required :bps, Float # @!attribute minimum_amount - # Inclusive tier starting value + # Exclusive tier starting value # # @return [String] required :minimum_amount, String # @!attribute maximum_amount - # Exclusive tier ending value + # Inclusive tier ending value # # @return [String, nil] optional :maximum_amount, String, nil?: true diff --git a/lib/orb/models/subscription_price_intervals_response.rb b/lib/orb/models/subscription_price_intervals_response.rb index a682ff8b..06650f70 100644 --- a/lib/orb/models/subscription_price_intervals_response.rb +++ b/lib/orb/models/subscription_price_intervals_response.rb @@ -154,6 +154,14 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -193,6 +201,16 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # @return [Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources }, + nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -213,12 +231,14 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionPriceIntervalsResponse::Status] # # @param trial_info [Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -240,12 +260,14 @@ class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1023,6 +1045,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionPriceIntervalsResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1219,6 +1258,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionPriceIntervalsResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/models/subscription_schedule_plan_change_params.rb b/lib/orb/models/subscription_schedule_plan_change_params.rb index 9b6f2d98..88b2d5ce 100644 --- a/lib/orb/models/subscription_schedule_plan_change_params.rb +++ b/lib/orb/models/subscription_schedule_plan_change_params.rb @@ -1938,7 +1938,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit - # Inclusive tier starting value + # Exclusive tier starting value # # @return [Float] required :first_unit, Float @@ -1950,7 +1950,7 @@ class Tier < Orb::Internal::Type::BaseModel required :unit_amount, String # @!attribute last_unit - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier # # @return [Float, nil] optional :last_unit, Float, nil?: true @@ -2254,13 +2254,13 @@ class Tier < Orb::Internal::Type::BaseModel required :bps, Float # @!attribute minimum_amount - # Inclusive tier starting value + # Exclusive tier starting value # # @return [String] required :minimum_amount, String # @!attribute maximum_amount - # Exclusive tier ending value + # Inclusive tier ending value # # @return [String, nil] optional :maximum_amount, String, nil?: true @@ -9374,7 +9374,7 @@ class TieredConfig < Orb::Internal::Type::BaseModel class Tier < Orb::Internal::Type::BaseModel # @!attribute first_unit - # Inclusive tier starting value + # Exclusive tier starting value # # @return [Float] required :first_unit, Float @@ -9386,7 +9386,7 @@ class Tier < Orb::Internal::Type::BaseModel required :unit_amount, String # @!attribute last_unit - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier # # @return [Float, nil] optional :last_unit, Float, nil?: true @@ -9690,13 +9690,13 @@ class Tier < Orb::Internal::Type::BaseModel required :bps, Float # @!attribute minimum_amount - # Inclusive tier starting value + # Exclusive tier starting value # # @return [String] required :minimum_amount, String # @!attribute maximum_amount - # Exclusive tier ending value + # Inclusive tier ending value # # @return [String, nil] optional :maximum_amount, String, nil?: true diff --git a/lib/orb/models/subscription_schedule_plan_change_response.rb b/lib/orb/models/subscription_schedule_plan_change_response.rb index ef4d3be2..8c1304f8 100644 --- a/lib/orb/models/subscription_schedule_plan_change_response.rb +++ b/lib/orb/models/subscription_schedule_plan_change_response.rb @@ -154,6 +154,14 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -193,6 +201,16 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # @return [Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources }, + nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -213,12 +231,14 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status] # # @param trial_info [Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -240,12 +260,14 @@ class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1023,6 +1045,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1219,6 +1258,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/models/subscription_trigger_phase_response.rb b/lib/orb/models/subscription_trigger_phase_response.rb index 1c75dd62..57c6cc0d 100644 --- a/lib/orb/models/subscription_trigger_phase_response.rb +++ b/lib/orb/models/subscription_trigger_phase_response.rb @@ -154,6 +154,14 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -193,6 +201,16 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # @return [Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources }, + nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -213,12 +231,14 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::Status] # # @param trial_info [Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -240,12 +260,14 @@ class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1023,6 +1045,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionTriggerPhaseResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1219,6 +1258,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionTriggerPhaseResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/models/subscription_unschedule_cancellation_response.rb b/lib/orb/models/subscription_unschedule_cancellation_response.rb index e1ad002e..f6eb957b 100644 --- a/lib/orb/models/subscription_unschedule_cancellation_response.rb +++ b/lib/orb/models/subscription_unschedule_cancellation_response.rb @@ -154,6 +154,14 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -193,6 +201,16 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # @return [Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources }, + nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -213,12 +231,14 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionUnscheduleCancellationResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status] # # @param trial_info [Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -240,12 +260,14 @@ class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseMode # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1023,6 +1045,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1219,6 +1258,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb index c558c121..8b549303 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 @@ -154,6 +154,14 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -193,6 +201,16 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources }, + nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -213,12 +231,14 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status] # # @param trial_info [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -240,12 +260,14 @@ class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Typ # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1023,6 +1045,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1223,6 +1262,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb b/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb index b7b671e9..3caa8ec2 100644 --- a/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +++ b/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb @@ -154,6 +154,14 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -193,6 +201,16 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # @return [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources }, + nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -213,12 +231,14 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status] # # @param trial_info [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -240,12 +260,14 @@ class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::Ba # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1023,6 +1045,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1219,6 +1258,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb b/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb index fc90be70..fab692bf 100644 --- a/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +++ b/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb @@ -154,6 +154,14 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -193,6 +201,16 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # @return [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources }, + nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -213,12 +231,14 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status] # # @param trial_info [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -240,12 +260,14 @@ class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseMode # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1023,6 +1045,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1219,6 +1258,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/models/subscription_update_trial_response.rb b/lib/orb/models/subscription_update_trial_response.rb index fc5dd2fe..97dfe022 100644 --- a/lib/orb/models/subscription_update_trial_response.rb +++ b/lib/orb/models/subscription_update_trial_response.rb @@ -154,6 +154,14 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # @return [Integer] required :net_terms, Integer + # @!attribute pending_subscription_change + # A pending subscription change if one exists on this subscription. + # + # @return [Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, nil] + required :pending_subscription_change, + -> { Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange }, + nil?: true + # @!attribute plan # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the @@ -191,6 +199,16 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # @return [Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo] required :trial_info, -> { Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo } + # @!attribute changed_resources + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + # + # @return [Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, nil] + optional :changed_resources, + -> { Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources }, + nil?: true + # @!parse # # @param id [String] # # @param active_plan_phase_order [Integer, nil] @@ -211,12 +229,14 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # # @param metadata [Hash{Symbol=>String}] # # @param minimum_intervals [Array] # # @param net_terms [Integer] + # # @param pending_subscription_change [Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, nil] # # @param plan [Orb::Models::Plan] # # @param price_intervals [Array] # # @param redeemed_coupon [Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon, nil] # # @param start_date [Time] # # @param status [Symbol, Orb::Models::SubscriptionUpdateTrialResponse::Status] # # @param trial_info [Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo] + # # @param changed_resources [Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, nil] # # # def initialize( # id:, @@ -238,12 +258,14 @@ class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel # metadata:, # minimum_intervals:, # net_terms:, + # pending_subscription_change:, # plan:, # price_intervals:, # redeemed_coupon:, # start_date:, # status:, # trial_info:, + # changed_resources: nil, # ** # ) # super @@ -1021,6 +1043,23 @@ class MinimumInterval < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + # @see Orb::Models::SubscriptionUpdateTrialResponse#pending_subscription_change + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + # @!attribute id + # + # @return [String] + required :id, String + + # @!parse + # # A pending subscription change if one exists on this subscription. + # # + # # @param id [String] + # # + # def initialize(id:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end + class PriceInterval < Orb::Internal::Type::BaseModel # @!attribute id # @@ -1217,6 +1256,47 @@ class TrialInfo < Orb::Internal::Type::BaseModel # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void end + + # @see Orb::Models::SubscriptionUpdateTrialResponse#changed_resources + class ChangedResources < Orb::Internal::Type::BaseModel + # @!attribute created_credit_notes + # The credit notes that were created as part of this operation. + # + # @return [Array] + required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute created_invoices + # The invoices that were created as part of this operation. + # + # @return [Array] + required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!attribute voided_credit_notes + # The credit notes that were voided as part of this operation. + # + # @return [Array] + required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] } + + # @!attribute voided_invoices + # The invoices that were voided as part of this operation. + # + # @return [Array] + required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] } + + # @!parse + # # The resources that were changed as part of this operation. Only present when + # # fetched through the subscription changes API or if the + # # `include_changed_resources` parameter was passed in the request. + # # + # # @param created_credit_notes [Array] + # # @param created_invoices [Array] + # # @param voided_credit_notes [Array] + # # @param voided_invoices [Array] + # # + # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super + + # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void + end end end end diff --git a/lib/orb/resources/subscription_changes.rb b/lib/orb/resources/subscription_changes.rb new file mode 100644 index 00000000..27ee80c1 --- /dev/null +++ b/lib/orb/resources/subscription_changes.rb @@ -0,0 +1,87 @@ +# frozen_string_literal: true + +module Orb + module Resources + class SubscriptionChanges + # This endpoint returns a subscription change given an identifier. + # + # A subscription change is created by including + # `Create-Pending-Subscription-Change: True` in the header of a subscription + # mutation API call (e.g. + # [create subscription endpoint](/api-reference/subscription/create-subscription), + # [schedule plan change endpoint](/api-reference/subscription/schedule-plan-change), + # ...). The subscription change will be referenced by the + # `pending_subscription_change` field in the response. + # + # @overload retrieve(subscription_change_id, request_options: {}) + # + # @param subscription_change_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Orb::Models::SubscriptionChangeRetrieveResponse] + # + # @see Orb::Models::SubscriptionChangeRetrieveParams + def retrieve(subscription_change_id, params = {}) + @client.request( + method: :get, + path: ["subscription_changes/%1$s", subscription_change_id], + model: Orb::Models::SubscriptionChangeRetrieveResponse, + options: params[:request_options] + ) + end + + # Apply a subscription change to perform the intended action. If a positive amount + # is passed with a request to this endpoint, any eligible invoices that were + # created will be issued immediately if they only contain in-advance fees. + # + # @overload apply(subscription_change_id, description: nil, previously_collected_amount: nil, request_options: {}) + # + # @param subscription_change_id [String] + # @param description [String, nil] + # @param previously_collected_amount [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Orb::Models::SubscriptionChangeApplyResponse] + # + # @see Orb::Models::SubscriptionChangeApplyParams + def apply(subscription_change_id, params = {}) + parsed, options = Orb::Models::SubscriptionChangeApplyParams.dump_request(params) + @client.request( + method: :post, + path: ["subscription_changes/%1$s/apply", subscription_change_id], + body: parsed, + model: Orb::Models::SubscriptionChangeApplyResponse, + options: options + ) + end + + # Cancel a subscription change. The change can no longer be applied. A + # subscription can only have one "pending" change at a time - use this endpoint to + # cancel an existing change before creating a new one. + # + # @overload cancel(subscription_change_id, request_options: {}) + # + # @param subscription_change_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Orb::Models::SubscriptionChangeCancelResponse] + # + # @see Orb::Models::SubscriptionChangeCancelParams + def cancel(subscription_change_id, params = {}) + @client.request( + method: :post, + path: ["subscription_changes/%1$s/cancel", subscription_change_id], + model: Orb::Models::SubscriptionChangeCancelResponse, + options: params[:request_options] + ) + end + + # @api private + # + # @param client [Orb::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/rbi/lib/orb/client.rbi b/rbi/lib/orb/client.rbi index 57ae1923..9a65af61 100644 --- a/rbi/lib/orb/client.rbi +++ b/rbi/lib/orb/client.rbi @@ -55,6 +55,9 @@ module Orb sig { returns(Orb::Resources::DimensionalPriceGroups) } attr_reader :dimensional_price_groups + sig { returns(Orb::Resources::SubscriptionChanges) } + attr_reader :subscription_changes + # @api private sig { override.returns(T::Hash[String, String]) } private def auth_headers; end diff --git a/rbi/lib/orb/models/invoice_create_params.rbi b/rbi/lib/orb/models/invoice_create_params.rbi index 3d70953b..d8ded73a 100644 --- a/rbi/lib/orb/models/invoice_create_params.rbi +++ b/rbi/lib/orb/models/invoice_create_params.rbi @@ -61,8 +61,9 @@ module Orb sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) } attr_accessor :metadata - # When true, this invoice will automatically be issued upon creation. When false, - # the resulting invoice will require manual review to issue. Defaulted to false. + # When true, this invoice will be submitted for issuance upon creation. When + # false, the resulting invoice will require manual review to issue. Defaulted to + # false. sig { returns(T.nilable(T::Boolean)) } attr_reader :will_auto_issue diff --git a/rbi/lib/orb/models/plan_create_params.rbi b/rbi/lib/orb/models/plan_create_params.rbi index 7dadd398..ec8ea2fa 100644 --- a/rbi/lib/orb/models/plan_create_params.rbi +++ b/rbi/lib/orb/models/plan_create_params.rbi @@ -1542,7 +1542,7 @@ module Orb def to_hash; end class Tier < Orb::Internal::Type::BaseModel - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(Float) } attr_accessor :first_unit @@ -1550,7 +1550,7 @@ module Orb sig { returns(String) } attr_accessor :unit_amount - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier sig { returns(T.nilable(Float)) } attr_accessor :last_unit @@ -1962,11 +1962,11 @@ module Orb sig { returns(Float) } attr_accessor :bps - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(String) } attr_accessor :minimum_amount - # Exclusive tier ending value + # Inclusive tier ending value sig { returns(T.nilable(String)) } attr_accessor :maximum_amount diff --git a/rbi/lib/orb/models/price.rbi b/rbi/lib/orb/models/price.rbi index 04561fbe..ed4aff59 100644 --- a/rbi/lib/orb/models/price.rbi +++ b/rbi/lib/orb/models/price.rbi @@ -2020,7 +2020,7 @@ module Orb def to_hash; end class Tier < Orb::Internal::Type::BaseModel - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(Float) } attr_accessor :first_unit @@ -2028,7 +2028,7 @@ module Orb sig { returns(String) } attr_accessor :unit_amount - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier sig { returns(T.nilable(Float)) } attr_accessor :last_unit @@ -2565,11 +2565,11 @@ module Orb sig { returns(Float) } attr_accessor :bps - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(String) } attr_accessor :minimum_amount - # Exclusive tier ending value + # Inclusive tier ending value sig { returns(T.nilable(String)) } attr_accessor :maximum_amount diff --git a/rbi/lib/orb/models/price_create_params.rbi b/rbi/lib/orb/models/price_create_params.rbi index c855aab4..d76ac410 100644 --- a/rbi/lib/orb/models/price_create_params.rbi +++ b/rbi/lib/orb/models/price_create_params.rbi @@ -665,7 +665,7 @@ module Orb def to_hash; end class Tier < Orb::Internal::Type::BaseModel - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(Float) } attr_accessor :first_unit @@ -673,7 +673,7 @@ module Orb sig { returns(String) } attr_accessor :unit_amount - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier sig { returns(T.nilable(Float)) } attr_accessor :last_unit @@ -713,11 +713,11 @@ module Orb sig { returns(Float) } attr_accessor :bps - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(String) } attr_accessor :minimum_amount - # Exclusive tier ending value + # Inclusive tier ending value sig { returns(T.nilable(String)) } attr_accessor :maximum_amount diff --git a/rbi/lib/orb/models/subscription.rbi b/rbi/lib/orb/models/subscription.rbi index 264c1567..725e8eb0 100644 --- a/rbi/lib/orb/models/subscription.rbi +++ b/rbi/lib/orb/models/subscription.rbi @@ -130,6 +130,18 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::Subscription::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable(T.any(Orb::Models::Subscription::PendingSubscriptionChange, Orb::Internal::AnyHash)) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -215,6 +227,7 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[T.any(Orb::Models::Subscription::MinimumInterval, Orb::Internal::AnyHash)], net_terms: Integer, + pending_subscription_change: T.nilable(T.any(Orb::Models::Subscription::PendingSubscriptionChange, Orb::Internal::AnyHash)), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[T.any(Orb::Models::Subscription::PriceInterval, Orb::Internal::AnyHash)], redeemed_coupon: T.nilable(T.any(Orb::Models::Subscription::RedeemedCoupon, Orb::Internal::AnyHash)), @@ -244,6 +257,7 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, @@ -280,6 +294,7 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::Subscription::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::Subscription::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::Subscription::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::Subscription::RedeemedCoupon), @@ -1070,6 +1085,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id diff --git a/rbi/lib/orb/models/subscription_cancel_response.rbi b/rbi/lib/orb/models/subscription_cancel_response.rbi index d0cae66c..6353c6ac 100644 --- a/rbi/lib/orb/models/subscription_cancel_response.rbi +++ b/rbi/lib/orb/models/subscription_cancel_response.rbi @@ -130,6 +130,20 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -168,6 +182,20 @@ module Orb sig { params(trial_info: T.any(Orb::Models::SubscriptionCancelResponse::TrialInfo, Orb::Internal::AnyHash)).void } attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionCancelResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable(T.any(Orb::Models::SubscriptionCancelResponse::ChangedResources, Orb::Internal::AnyHash)) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -196,12 +224,16 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionCancelResponse::MinimumInterval, Orb::Internal::AnyHash)], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[T.any(Orb::Models::SubscriptionCancelResponse::PriceInterval, Orb::Internal::AnyHash)], redeemed_coupon: T.nilable(T.any(Orb::Models::SubscriptionCancelResponse::RedeemedCoupon, Orb::Internal::AnyHash)), start_date: Time, status: Orb::Models::SubscriptionCancelResponse::Status::OrSymbol, - trial_info: T.any(Orb::Models::SubscriptionCancelResponse::TrialInfo, Orb::Internal::AnyHash) + trial_info: T.any(Orb::Models::SubscriptionCancelResponse::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable(T.any(Orb::Models::SubscriptionCancelResponse::ChangedResources, Orb::Internal::AnyHash)) ) .returns(T.attached_class) end @@ -225,12 +257,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -261,12 +295,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionCancelResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionCancelResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionCancelResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo + trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionCancelResponse::ChangedResources) } ) end @@ -1051,6 +1087,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1322,6 +1370,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/models/subscription_change_apply_params.rbi b/rbi/lib/orb/models/subscription_change_apply_params.rbi new file mode 100644 index 00000000..679feea8 --- /dev/null +++ b/rbi/lib/orb/models/subscription_change_apply_params.rbi @@ -0,0 +1,40 @@ +# typed: strong + +module Orb + module Models + class SubscriptionChangeApplyParams < Orb::Internal::Type::BaseModel + extend Orb::Internal::Type::RequestParameters::Converter + include Orb::Internal::Type::RequestParameters + + # Description to apply to the balance transaction representing this credit. + sig { returns(T.nilable(String)) } + attr_accessor :description + + # Amount already collected to apply to the customer's balance. + sig { returns(T.nilable(String)) } + attr_accessor :previously_collected_amount + + sig do + params( + description: T.nilable(String), + previously_collected_amount: T.nilable(String), + request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash) + ) + .returns(T.attached_class) + end + def self.new(description: nil, previously_collected_amount: nil, request_options: {}); end + + sig do + override + .returns( + { + description: T.nilable(String), + previously_collected_amount: T.nilable(String), + request_options: Orb::RequestOptions + } + ) + end + def to_hash; end + end + end +end diff --git a/rbi/lib/orb/models/subscription_change_apply_response.rbi b/rbi/lib/orb/models/subscription_change_apply_response.rbi new file mode 100644 index 00000000..0c78e7a4 --- /dev/null +++ b/rbi/lib/orb/models/subscription_change_apply_response.rbi @@ -0,0 +1,1554 @@ +# typed: strong + +module Orb + module Models + class SubscriptionChangeApplyResponse < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # Subscription change will be cancelled at this time and can no longer be applied. + sig { returns(Time) } + attr_accessor :expiration_time + + sig { returns(Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol) } + attr_accessor :status + + sig { returns(T.nilable(Orb::Models::SubscriptionChangeApplyResponse::Subscription)) } + attr_reader :subscription + + sig do + params( + subscription: T.nilable(T.any(Orb::Models::SubscriptionChangeApplyResponse::Subscription, Orb::Internal::AnyHash)) + ) + .void + end + attr_writer :subscription + + # When this change was applied. + sig { returns(T.nilable(Time)) } + attr_accessor :applied_at + + # When this change was cancelled. + sig { returns(T.nilable(Time)) } + attr_accessor :cancelled_at + + # A subscription change represents a desired new subscription / pending change to + # an existing subscription. It is a way to first preview the effects on the + # subscription as well as any changes/creation of invoices (see + # `subscription.changed_resources`). + sig do + params( + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeApplyResponse::Status::OrSymbol, + subscription: T.nilable(T.any(Orb::Models::SubscriptionChangeApplyResponse::Subscription, Orb::Internal::AnyHash)), + applied_at: T.nilable(Time), + cancelled_at: T.nilable(Time) + ) + .returns(T.attached_class) + end + def self.new(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil); end + + sig do + override + .returns( + { + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol, + subscription: T.nilable(Orb::Models::SubscriptionChangeApplyResponse::Subscription), + applied_at: T.nilable(Time), + cancelled_at: T.nilable(Time) + } + ) + end + def to_hash; end + + module Status + extend Orb::Internal::Type::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeApplyResponse::Status) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol) } + + PENDING = T.let(:pending, Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol) + APPLIED = T.let(:applied, Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol) + CANCELLED = T.let(:cancelled, Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol) + + sig { override.returns(T::Array[Orb::Models::SubscriptionChangeApplyResponse::Status::TaggedSymbol]) } + def self.values; end + end + + class Subscription < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # The current plan phase that is active, only if the subscription's plan has + # phases. + sig { returns(T.nilable(Integer)) } + attr_accessor :active_plan_phase_order + + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. + sig { returns(T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval]) } + attr_accessor :adjustment_intervals + + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :auto_collection + + sig { returns(Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration) } + attr_reader :billing_cycle_anchor_configuration + + sig do + params( + billing_cycle_anchor_configuration: T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration, + Orb::Internal::AnyHash + ) + ) + .void + end + attr_writer :billing_cycle_anchor_configuration + + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + sig { returns(Integer) } + attr_accessor :billing_cycle_day + + sig { returns(Time) } + attr_accessor :created_at + + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_end_date + + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_start_date + + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. + sig { returns(Orb::Models::Customer) } + attr_reader :customer + + sig { params(customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash)).void } + attr_writer :customer + + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. + sig { returns(T.nilable(String)) } + attr_accessor :default_invoice_memo + + # The discount intervals for this subscription sorted by the start_date. + sig do + returns( + T::Array[ + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval + ) + ] + ) + end + attr_accessor :discount_intervals + + # The date Orb stops billing for this subscription. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { returns(T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::FixedFeeQuantitySchedule]) } + attr_accessor :fixed_fee_quantity_schedule + + sig { returns(T.nilable(String)) } + attr_accessor :invoicing_threshold + + # The maximum intervals for this subscription sorted by the start_date. + sig { returns(T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval]) } + attr_accessor :maximum_intervals + + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. + sig { returns(T::Hash[Symbol, String]) } + attr_accessor :metadata + + # The minimum intervals for this subscription sorted by the start_date. + sig { returns(T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval]) } + attr_accessor :minimum_intervals + + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. + sig { returns(Integer) } + attr_accessor :net_terms + + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :pending_subscription_change + + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). + sig { returns(Orb::Models::Plan) } + attr_reader :plan + + sig { params(plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash)).void } + attr_writer :plan + + # The price intervals for this subscription. + sig { returns(T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval]) } + attr_accessor :price_intervals + + sig { returns(T.nilable(Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon)) } + attr_reader :redeemed_coupon + + sig do + params( + redeemed_coupon: T.nilable( + T.any(Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :redeemed_coupon + + # The date Orb starts billing for this subscription. + sig { returns(Time) } + attr_accessor :start_date + + sig { returns(Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol) } + attr_accessor :status + + sig { returns(Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo) } + attr_reader :trial_info + + sig do + params( + trial_info: T.any(Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo, Orb::Internal::AnyHash) + ) + .void + end + attr_writer :trial_info + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :changed_resources + + sig do + params( + id: String, + active_plan_phase_order: T.nilable(Integer), + adjustment_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval, + Orb::Internal::AnyHash + ) + ], + auto_collection: T.nilable(T::Boolean), + billing_cycle_anchor_configuration: T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration, + Orb::Internal::AnyHash + ), + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), + default_invoice_memo: T.nilable(String), + discount_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval + ) + ], + end_date: T.nilable(Time), + fixed_fee_quantity_schedule: T::Array[ + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::FixedFeeQuantitySchedule, + Orb::Internal::AnyHash + ) + ], + invoicing_threshold: T.nilable(String), + maximum_intervals: T::Array[T.any(Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval, Orb::Internal::AnyHash)], + metadata: T::Hash[Symbol, String], + minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval, Orb::Internal::AnyHash)], + net_terms: Integer, + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ), + plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), + price_intervals: T::Array[T.any(Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval, Orb::Internal::AnyHash)], + redeemed_coupon: T.nilable( + T.any(Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon, Orb::Internal::AnyHash) + ), + start_date: Time, + status: Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::OrSymbol, + trial_info: T.any(Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources, + Orb::Internal::AnyHash + ) + ) + ) + .returns(T.attached_class) + end + def self.new( + id:, + active_plan_phase_order:, + adjustment_intervals:, + auto_collection:, + billing_cycle_anchor_configuration:, + billing_cycle_day:, + created_at:, + current_billing_period_end_date:, + current_billing_period_start_date:, + customer:, + default_invoice_memo:, + discount_intervals:, + end_date:, + fixed_fee_quantity_schedule:, + invoicing_threshold:, + maximum_intervals:, + metadata:, + minimum_intervals:, + net_terms:, + pending_subscription_change:, + plan:, + price_intervals:, + redeemed_coupon:, + start_date:, + status:, + trial_info:, + changed_resources: nil + ); end + sig do + override + .returns( + { + id: String, + active_plan_phase_order: T.nilable(Integer), + adjustment_intervals: T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval], + auto_collection: T.nilable(T::Boolean), + billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + customer: Orb::Models::Customer, + default_invoice_memo: T.nilable(String), + discount_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval + ) + ], + end_date: T.nilable(Time), + fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::FixedFeeQuantitySchedule], + invoicing_threshold: T.nilable(String), + maximum_intervals: T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval], + metadata: T::Hash[Symbol, String], + minimum_intervals: T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval], + net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange), + plan: Orb::Models::Plan, + price_intervals: T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval], + redeemed_coupon: T.nilable(Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon), + start_date: Time, + status: Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol, + trial_info: Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources) + } + ) + end + def to_hash; end + + class AdjustmentInterval < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig do + returns( + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + ) + ) + end + attr_accessor :adjustment + + # The price interval IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + # The end date of the adjustment interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The start date of the adjustment interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + id: String, + adjustment: T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + ), + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time + ) + .returns(T.attached_class) + end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end + + sig do + override + .returns( + { + id: String, + adjustment: T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + ), + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time + } + ) + end + def to_hash; end + + module Adjustment + extend Orb::Internal::Type::Union + + class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. + sig { returns(Float) } + attr_accessor :usage_discount + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + usage_discount: Float, + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + plan_phase_order:, + reason:, + usage_discount:, + adjustment_type: :usage_discount + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + usage_discount: Float + } + ) + end + def to_hash; end + end + + class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. + sig { returns(String) } + attr_accessor :amount_discount + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + amount_discount: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + amount_discount:, + applies_to_price_ids:, + is_invoice_level:, + plan_phase_order:, + reason:, + adjustment_type: :amount_discount + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + amount_discount: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. + sig { returns(Float) } + attr_accessor :percentage_discount + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + percentage_discount: Float, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + percentage_discount:, + plan_phase_order:, + reason:, + adjustment_type: :percentage_discount + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + percentage_discount: Float, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The item ID that revenue from this minimum will be attributed to. + sig { returns(String) } + attr_accessor :item_id + + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. + sig { returns(String) } + attr_accessor :minimum_amount + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + item_id: String, + minimum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + item_id:, + minimum_amount:, + plan_phase_order:, + reason:, + adjustment_type: :minimum + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + item_id: String, + minimum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. + sig { returns(String) } + attr_accessor :maximum_amount + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + maximum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + maximum_amount:, + plan_phase_order:, + reason:, + adjustment_type: :maximum + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + maximum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + sig do + override + .returns( + [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + ) + end + def self.variants; end + end + end + + class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + sig { returns(Integer) } + attr_accessor :day + + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + sig { returns(T.nilable(Integer)) } + attr_accessor :month + + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + sig { returns(T.nilable(Integer)) } + attr_accessor :year + + sig do + params( + day: Integer, + month: T.nilable(Integer), + year: T.nilable(Integer) + ).returns(T.attached_class) + end + def self.new(day:, month: nil, year: nil); end + + sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } + def to_hash; end + end + + module DiscountInterval + extend Orb::Internal::Type::Union + + class AmountDiscountInterval < Orb::Internal::Type::BaseModel + # Only available if discount_type is `amount`. + sig { returns(String) } + attr_accessor :amount_discount + + # The price ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + sig { returns(Symbol) } + attr_accessor :discount_type + + # The end date of the discount interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The start date of the discount interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + amount_discount: String, + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time, + discount_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + amount_discount:, + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + start_date:, + discount_type: :amount + ); end + sig do + override + .returns( + { + amount_discount: String, + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + discount_type: Symbol, + end_date: T.nilable(Time), + start_date: Time + } + ) + end + def to_hash; end + end + + class PercentageDiscountInterval < Orb::Internal::Type::BaseModel + # The price ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + sig { returns(Symbol) } + attr_accessor :discount_type + + # The end date of the discount interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. + sig { returns(Float) } + attr_accessor :percentage_discount + + # The start date of the discount interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + percentage_discount: Float, + start_date: Time, + discount_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + percentage_discount:, + start_date:, + discount_type: :percentage + ); end + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + discount_type: Symbol, + end_date: T.nilable(Time), + percentage_discount: Float, + start_date: Time + } + ) + end + def to_hash; end + end + + class UsageDiscountInterval < Orb::Internal::Type::BaseModel + # The price ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + sig { returns(Symbol) } + attr_accessor :discount_type + + # The end date of the discount interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The start date of the discount interval. + sig { returns(Time) } + attr_accessor :start_date + + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + sig { returns(Float) } + attr_accessor :usage_discount + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time, + usage_discount: Float, + discount_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + start_date:, + usage_discount:, + discount_type: :usage + ); end + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + discount_type: Symbol, + end_date: T.nilable(Time), + start_date: Time, + usage_discount: Float + } + ) + end + def to_hash; end + end + + sig do + override + .returns( + [Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval] + ) + end + def self.variants; end + end + + class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { returns(String) } + attr_accessor :price_id + + sig { returns(Float) } + attr_accessor :quantity + + sig { returns(Time) } + attr_accessor :start_date + + sig do + params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) + .returns(T.attached_class) + end + def self.new(end_date:, price_id:, quantity:, start_date:); end + + sig do + override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) + end + def to_hash; end + end + + class MaximumInterval < Orb::Internal::Type::BaseModel + # The price ids that this maximum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this maximum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + # The end date of the maximum interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. + sig { returns(String) } + attr_accessor :maximum_amount + + # The start date of the maximum interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + maximum_amount: String, + start_date: Time + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + maximum_amount:, + start_date: + ) + end + + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + maximum_amount: String, + start_date: Time + } + ) + end + def to_hash; end + end + + class MinimumInterval < Orb::Internal::Type::BaseModel + # The price ids that this minimum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this minimum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + # The end date of the minimum interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. + sig { returns(String) } + attr_accessor :minimum_amount + + # The start date of the minimum interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + minimum_amount: String, + start_date: Time + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + minimum_amount:, + start_date: + ) + end + + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + minimum_amount: String, + start_date: Time + } + ) + end + def to_hash; end + end + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + + class PriceInterval < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # The day of the month that Orb bills for this price + sig { returns(Integer) } + attr_accessor :billing_cycle_day + + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_end_date + + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_start_date + + # The end date of the price interval. This is the date that Orb stops billing for + # this price. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # An additional filter to apply to usage queries. + sig { returns(T.nilable(String)) } + attr_accessor :filter + + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. + sig do + returns( + T.nilable( + T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] + ) + ) + end + attr_accessor :fixed_fee_quantity_transitions + + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) + sig do + returns( + T.any( + Orb::Models::Price::UnitPrice, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ) + ) + end + attr_accessor :price + + # The start date of the price interval. This is the date that Orb starts billing + # for this price. + sig { returns(Time) } + attr_accessor :start_date + + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :usage_customer_ids + + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + sig do + params( + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + end_date: T.nilable(Time), + filter: T.nilable(String), + fixed_fee_quantity_transitions: T.nilable( + T::Array[ + T.any( + Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) + ] + ), + price: T.any( + Orb::Models::Price::UnitPrice, + Orb::Internal::AnyHash, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ), + start_date: Time, + usage_customer_ids: T.nilable(T::Array[String]) + ) + .returns(T.attached_class) + end + def self.new( + id:, + billing_cycle_day:, + current_billing_period_end_date:, + current_billing_period_start_date:, + end_date:, + filter:, + fixed_fee_quantity_transitions:, + price:, + start_date:, + usage_customer_ids: + ); end + sig do + override + .returns( + { + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + end_date: T.nilable(Time), + filter: T.nilable(String), + fixed_fee_quantity_transitions: T.nilable( + T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] + ), + price: T.any( + Orb::Models::Price::UnitPrice, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ), + start_date: Time, + usage_customer_ids: T.nilable(T::Array[String]) + } + ) + end + def to_hash; end + + class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel + sig { returns(Time) } + attr_accessor :effective_date + + sig { returns(String) } + attr_accessor :price_id + + sig { returns(Integer) } + attr_accessor :quantity + + sig do + params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) + end + def self.new(effective_date:, price_id:, quantity:); end + + sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } + def to_hash; end + end + end + + class RedeemedCoupon < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :coupon_id + + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { returns(Time) } + attr_accessor :start_date + + sig do + params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) + end + def self.new(coupon_id:, end_date:, start_date:); end + + sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } + def to_hash; end + end + + module Status + extend Orb::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol) } + + ACTIVE = T.let(:active, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol) + ENDED = T.let(:ended, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol) + UPCOMING = + T.let(:upcoming, Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol) + + sig do + override + .returns(T::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::Status::TaggedSymbol]) + end + def self.values; end + end + + class TrialInfo < Orb::Internal::Type::BaseModel + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } + def self.new(end_date:); end + + sig { override.returns({end_date: T.nilable(Time)}) } + def to_hash; end + end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end + end + end + end +end diff --git a/rbi/lib/orb/models/subscription_change_cancel_params.rbi b/rbi/lib/orb/models/subscription_change_cancel_params.rbi new file mode 100644 index 00000000..9a255d08 --- /dev/null +++ b/rbi/lib/orb/models/subscription_change_cancel_params.rbi @@ -0,0 +1,18 @@ +# typed: strong + +module Orb + module Models + class SubscriptionChangeCancelParams < Orb::Internal::Type::BaseModel + extend Orb::Internal::Type::RequestParameters::Converter + include Orb::Internal::Type::RequestParameters + + sig do + params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) + end + def self.new(request_options: {}); end + + sig { override.returns({request_options: Orb::RequestOptions}) } + def to_hash; end + end + end +end diff --git a/rbi/lib/orb/models/subscription_change_cancel_response.rbi b/rbi/lib/orb/models/subscription_change_cancel_response.rbi new file mode 100644 index 00000000..50a9e0f4 --- /dev/null +++ b/rbi/lib/orb/models/subscription_change_cancel_response.rbi @@ -0,0 +1,1565 @@ +# typed: strong + +module Orb + module Models + class SubscriptionChangeCancelResponse < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # Subscription change will be cancelled at this time and can no longer be applied. + sig { returns(Time) } + attr_accessor :expiration_time + + sig { returns(Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol) } + attr_accessor :status + + sig { returns(T.nilable(Orb::Models::SubscriptionChangeCancelResponse::Subscription)) } + attr_reader :subscription + + sig do + params( + subscription: T.nilable(T.any(Orb::Models::SubscriptionChangeCancelResponse::Subscription, Orb::Internal::AnyHash)) + ) + .void + end + attr_writer :subscription + + # When this change was applied. + sig { returns(T.nilable(Time)) } + attr_accessor :applied_at + + # When this change was cancelled. + sig { returns(T.nilable(Time)) } + attr_accessor :cancelled_at + + # A subscription change represents a desired new subscription / pending change to + # an existing subscription. It is a way to first preview the effects on the + # subscription as well as any changes/creation of invoices (see + # `subscription.changed_resources`). + sig do + params( + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeCancelResponse::Status::OrSymbol, + subscription: T.nilable(T.any(Orb::Models::SubscriptionChangeCancelResponse::Subscription, Orb::Internal::AnyHash)), + applied_at: T.nilable(Time), + cancelled_at: T.nilable(Time) + ) + .returns(T.attached_class) + end + def self.new(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil); end + + sig do + override + .returns( + { + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol, + subscription: T.nilable(Orb::Models::SubscriptionChangeCancelResponse::Subscription), + applied_at: T.nilable(Time), + cancelled_at: T.nilable(Time) + } + ) + end + def to_hash; end + + module Status + extend Orb::Internal::Type::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeCancelResponse::Status) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol) } + + PENDING = T.let(:pending, Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol) + APPLIED = T.let(:applied, Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol) + CANCELLED = T.let(:cancelled, Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol) + + sig { override.returns(T::Array[Orb::Models::SubscriptionChangeCancelResponse::Status::TaggedSymbol]) } + def self.values; end + end + + class Subscription < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # The current plan phase that is active, only if the subscription's plan has + # phases. + sig { returns(T.nilable(Integer)) } + attr_accessor :active_plan_phase_order + + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. + sig { returns(T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval]) } + attr_accessor :adjustment_intervals + + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :auto_collection + + sig { returns(Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration) } + attr_reader :billing_cycle_anchor_configuration + + sig do + params( + billing_cycle_anchor_configuration: T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration, + Orb::Internal::AnyHash + ) + ) + .void + end + attr_writer :billing_cycle_anchor_configuration + + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + sig { returns(Integer) } + attr_accessor :billing_cycle_day + + sig { returns(Time) } + attr_accessor :created_at + + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_end_date + + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_start_date + + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. + sig { returns(Orb::Models::Customer) } + attr_reader :customer + + sig { params(customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash)).void } + attr_writer :customer + + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. + sig { returns(T.nilable(String)) } + attr_accessor :default_invoice_memo + + # The discount intervals for this subscription sorted by the start_date. + sig do + returns( + T::Array[ + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval + ) + ] + ) + end + attr_accessor :discount_intervals + + # The date Orb stops billing for this subscription. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { returns(T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::FixedFeeQuantitySchedule]) } + attr_accessor :fixed_fee_quantity_schedule + + sig { returns(T.nilable(String)) } + attr_accessor :invoicing_threshold + + # The maximum intervals for this subscription sorted by the start_date. + sig { returns(T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval]) } + attr_accessor :maximum_intervals + + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. + sig { returns(T::Hash[Symbol, String]) } + attr_accessor :metadata + + # The minimum intervals for this subscription sorted by the start_date. + sig { returns(T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval]) } + attr_accessor :minimum_intervals + + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. + sig { returns(Integer) } + attr_accessor :net_terms + + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :pending_subscription_change + + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). + sig { returns(Orb::Models::Plan) } + attr_reader :plan + + sig { params(plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash)).void } + attr_writer :plan + + # The price intervals for this subscription. + sig { returns(T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval]) } + attr_accessor :price_intervals + + sig { returns(T.nilable(Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon)) } + attr_reader :redeemed_coupon + + sig do + params( + redeemed_coupon: T.nilable( + T.any(Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :redeemed_coupon + + # The date Orb starts billing for this subscription. + sig { returns(Time) } + attr_accessor :start_date + + sig { returns(Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::TaggedSymbol) } + attr_accessor :status + + sig { returns(Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo) } + attr_reader :trial_info + + sig do + params( + trial_info: T.any(Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo, Orb::Internal::AnyHash) + ) + .void + end + attr_writer :trial_info + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :changed_resources + + sig do + params( + id: String, + active_plan_phase_order: T.nilable(Integer), + adjustment_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval, + Orb::Internal::AnyHash + ) + ], + auto_collection: T.nilable(T::Boolean), + billing_cycle_anchor_configuration: T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration, + Orb::Internal::AnyHash + ), + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), + default_invoice_memo: T.nilable(String), + discount_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval + ) + ], + end_date: T.nilable(Time), + fixed_fee_quantity_schedule: T::Array[ + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::FixedFeeQuantitySchedule, + Orb::Internal::AnyHash + ) + ], + invoicing_threshold: T.nilable(String), + maximum_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval, + Orb::Internal::AnyHash + ) + ], + metadata: T::Hash[Symbol, String], + minimum_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval, + Orb::Internal::AnyHash + ) + ], + net_terms: Integer, + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ), + plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), + price_intervals: T::Array[T.any(Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval, Orb::Internal::AnyHash)], + redeemed_coupon: T.nilable( + T.any(Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon, Orb::Internal::AnyHash) + ), + start_date: Time, + status: Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::OrSymbol, + trial_info: T.any(Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources, + Orb::Internal::AnyHash + ) + ) + ) + .returns(T.attached_class) + end + def self.new( + id:, + active_plan_phase_order:, + adjustment_intervals:, + auto_collection:, + billing_cycle_anchor_configuration:, + billing_cycle_day:, + created_at:, + current_billing_period_end_date:, + current_billing_period_start_date:, + customer:, + default_invoice_memo:, + discount_intervals:, + end_date:, + fixed_fee_quantity_schedule:, + invoicing_threshold:, + maximum_intervals:, + metadata:, + minimum_intervals:, + net_terms:, + pending_subscription_change:, + plan:, + price_intervals:, + redeemed_coupon:, + start_date:, + status:, + trial_info:, + changed_resources: nil + ); end + sig do + override + .returns( + { + id: String, + active_plan_phase_order: T.nilable(Integer), + adjustment_intervals: T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval], + auto_collection: T.nilable(T::Boolean), + billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + customer: Orb::Models::Customer, + default_invoice_memo: T.nilable(String), + discount_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval + ) + ], + end_date: T.nilable(Time), + fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::FixedFeeQuantitySchedule], + invoicing_threshold: T.nilable(String), + maximum_intervals: T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval], + metadata: T::Hash[Symbol, String], + minimum_intervals: T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval], + net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange), + plan: Orb::Models::Plan, + price_intervals: T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval], + redeemed_coupon: T.nilable(Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon), + start_date: Time, + status: Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::TaggedSymbol, + trial_info: Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources) + } + ) + end + def to_hash; end + + class AdjustmentInterval < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig do + returns( + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + ) + ) + end + attr_accessor :adjustment + + # The price interval IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + # The end date of the adjustment interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The start date of the adjustment interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + id: String, + adjustment: T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + ), + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time + ) + .returns(T.attached_class) + end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end + + sig do + override + .returns( + { + id: String, + adjustment: T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + ), + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time + } + ) + end + def to_hash; end + + module Adjustment + extend Orb::Internal::Type::Union + + class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. + sig { returns(Float) } + attr_accessor :usage_discount + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + usage_discount: Float, + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + plan_phase_order:, + reason:, + usage_discount:, + adjustment_type: :usage_discount + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + usage_discount: Float + } + ) + end + def to_hash; end + end + + class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. + sig { returns(String) } + attr_accessor :amount_discount + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + amount_discount: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + amount_discount:, + applies_to_price_ids:, + is_invoice_level:, + plan_phase_order:, + reason:, + adjustment_type: :amount_discount + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + amount_discount: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. + sig { returns(Float) } + attr_accessor :percentage_discount + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + percentage_discount: Float, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + percentage_discount:, + plan_phase_order:, + reason:, + adjustment_type: :percentage_discount + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + percentage_discount: Float, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The item ID that revenue from this minimum will be attributed to. + sig { returns(String) } + attr_accessor :item_id + + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. + sig { returns(String) } + attr_accessor :minimum_amount + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + item_id: String, + minimum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + item_id:, + minimum_amount:, + plan_phase_order:, + reason:, + adjustment_type: :minimum + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + item_id: String, + minimum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. + sig { returns(String) } + attr_accessor :maximum_amount + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + maximum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + maximum_amount:, + plan_phase_order:, + reason:, + adjustment_type: :maximum + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + maximum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + sig do + override + .returns( + [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + ) + end + def self.variants; end + end + end + + class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + sig { returns(Integer) } + attr_accessor :day + + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + sig { returns(T.nilable(Integer)) } + attr_accessor :month + + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + sig { returns(T.nilable(Integer)) } + attr_accessor :year + + sig do + params( + day: Integer, + month: T.nilable(Integer), + year: T.nilable(Integer) + ).returns(T.attached_class) + end + def self.new(day:, month: nil, year: nil); end + + sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } + def to_hash; end + end + + module DiscountInterval + extend Orb::Internal::Type::Union + + class AmountDiscountInterval < Orb::Internal::Type::BaseModel + # Only available if discount_type is `amount`. + sig { returns(String) } + attr_accessor :amount_discount + + # The price ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + sig { returns(Symbol) } + attr_accessor :discount_type + + # The end date of the discount interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The start date of the discount interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + amount_discount: String, + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time, + discount_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + amount_discount:, + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + start_date:, + discount_type: :amount + ); end + sig do + override + .returns( + { + amount_discount: String, + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + discount_type: Symbol, + end_date: T.nilable(Time), + start_date: Time + } + ) + end + def to_hash; end + end + + class PercentageDiscountInterval < Orb::Internal::Type::BaseModel + # The price ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + sig { returns(Symbol) } + attr_accessor :discount_type + + # The end date of the discount interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. + sig { returns(Float) } + attr_accessor :percentage_discount + + # The start date of the discount interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + percentage_discount: Float, + start_date: Time, + discount_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + percentage_discount:, + start_date:, + discount_type: :percentage + ); end + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + discount_type: Symbol, + end_date: T.nilable(Time), + percentage_discount: Float, + start_date: Time + } + ) + end + def to_hash; end + end + + class UsageDiscountInterval < Orb::Internal::Type::BaseModel + # The price ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + sig { returns(Symbol) } + attr_accessor :discount_type + + # The end date of the discount interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The start date of the discount interval. + sig { returns(Time) } + attr_accessor :start_date + + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + sig { returns(Float) } + attr_accessor :usage_discount + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time, + usage_discount: Float, + discount_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + start_date:, + usage_discount:, + discount_type: :usage + ); end + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + discount_type: Symbol, + end_date: T.nilable(Time), + start_date: Time, + usage_discount: Float + } + ) + end + def to_hash; end + end + + sig do + override + .returns( + [Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval] + ) + end + def self.variants; end + end + + class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { returns(String) } + attr_accessor :price_id + + sig { returns(Float) } + attr_accessor :quantity + + sig { returns(Time) } + attr_accessor :start_date + + sig do + params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) + .returns(T.attached_class) + end + def self.new(end_date:, price_id:, quantity:, start_date:); end + + sig do + override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) + end + def to_hash; end + end + + class MaximumInterval < Orb::Internal::Type::BaseModel + # The price ids that this maximum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this maximum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + # The end date of the maximum interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. + sig { returns(String) } + attr_accessor :maximum_amount + + # The start date of the maximum interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + maximum_amount: String, + start_date: Time + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + maximum_amount:, + start_date: + ) + end + + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + maximum_amount: String, + start_date: Time + } + ) + end + def to_hash; end + end + + class MinimumInterval < Orb::Internal::Type::BaseModel + # The price ids that this minimum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this minimum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + # The end date of the minimum interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. + sig { returns(String) } + attr_accessor :minimum_amount + + # The start date of the minimum interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + minimum_amount: String, + start_date: Time + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + minimum_amount:, + start_date: + ) + end + + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + minimum_amount: String, + start_date: Time + } + ) + end + def to_hash; end + end + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + + class PriceInterval < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # The day of the month that Orb bills for this price + sig { returns(Integer) } + attr_accessor :billing_cycle_day + + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_end_date + + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_start_date + + # The end date of the price interval. This is the date that Orb stops billing for + # this price. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # An additional filter to apply to usage queries. + sig { returns(T.nilable(String)) } + attr_accessor :filter + + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. + sig do + returns( + T.nilable( + T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] + ) + ) + end + attr_accessor :fixed_fee_quantity_transitions + + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) + sig do + returns( + T.any( + Orb::Models::Price::UnitPrice, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ) + ) + end + attr_accessor :price + + # The start date of the price interval. This is the date that Orb starts billing + # for this price. + sig { returns(Time) } + attr_accessor :start_date + + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :usage_customer_ids + + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + sig do + params( + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + end_date: T.nilable(Time), + filter: T.nilable(String), + fixed_fee_quantity_transitions: T.nilable( + T::Array[ + T.any( + Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) + ] + ), + price: T.any( + Orb::Models::Price::UnitPrice, + Orb::Internal::AnyHash, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ), + start_date: Time, + usage_customer_ids: T.nilable(T::Array[String]) + ) + .returns(T.attached_class) + end + def self.new( + id:, + billing_cycle_day:, + current_billing_period_end_date:, + current_billing_period_start_date:, + end_date:, + filter:, + fixed_fee_quantity_transitions:, + price:, + start_date:, + usage_customer_ids: + ); end + sig do + override + .returns( + { + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + end_date: T.nilable(Time), + filter: T.nilable(String), + fixed_fee_quantity_transitions: T.nilable( + T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] + ), + price: T.any( + Orb::Models::Price::UnitPrice, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ), + start_date: Time, + usage_customer_ids: T.nilable(T::Array[String]) + } + ) + end + def to_hash; end + + class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel + sig { returns(Time) } + attr_accessor :effective_date + + sig { returns(String) } + attr_accessor :price_id + + sig { returns(Integer) } + attr_accessor :quantity + + sig do + params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) + end + def self.new(effective_date:, price_id:, quantity:); end + + sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } + def to_hash; end + end + end + + class RedeemedCoupon < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :coupon_id + + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { returns(Time) } + attr_accessor :start_date + + sig do + params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) + end + def self.new(coupon_id:, end_date:, start_date:); end + + sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } + def to_hash; end + end + + module Status + extend Orb::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::TaggedSymbol) } + + ACTIVE = + T.let(:active, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::TaggedSymbol) + ENDED = T.let(:ended, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::TaggedSymbol) + UPCOMING = + T.let(:upcoming, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::TaggedSymbol) + + sig do + override + .returns(T::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status::TaggedSymbol]) + end + def self.values; end + end + + class TrialInfo < Orb::Internal::Type::BaseModel + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } + def self.new(end_date:); end + + sig { override.returns({end_date: T.nilable(Time)}) } + def to_hash; end + end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end + end + end + end +end diff --git a/rbi/lib/orb/models/subscription_change_retrieve_params.rbi b/rbi/lib/orb/models/subscription_change_retrieve_params.rbi new file mode 100644 index 00000000..d00b5792 --- /dev/null +++ b/rbi/lib/orb/models/subscription_change_retrieve_params.rbi @@ -0,0 +1,18 @@ +# typed: strong + +module Orb + module Models + class SubscriptionChangeRetrieveParams < Orb::Internal::Type::BaseModel + extend Orb::Internal::Type::RequestParameters::Converter + include Orb::Internal::Type::RequestParameters + + sig do + params(request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)).returns(T.attached_class) + end + def self.new(request_options: {}); end + + sig { override.returns({request_options: Orb::RequestOptions}) } + def to_hash; end + end + end +end diff --git a/rbi/lib/orb/models/subscription_change_retrieve_response.rbi b/rbi/lib/orb/models/subscription_change_retrieve_response.rbi new file mode 100644 index 00000000..f4576676 --- /dev/null +++ b/rbi/lib/orb/models/subscription_change_retrieve_response.rbi @@ -0,0 +1,1581 @@ +# typed: strong + +module Orb + module Models + class SubscriptionChangeRetrieveResponse < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # Subscription change will be cancelled at this time and can no longer be applied. + sig { returns(Time) } + attr_accessor :expiration_time + + sig { returns(Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol) } + attr_accessor :status + + sig { returns(T.nilable(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription)) } + attr_reader :subscription + + sig do + params( + subscription: T.nilable(T.any(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription, Orb::Internal::AnyHash)) + ) + .void + end + attr_writer :subscription + + # When this change was applied. + sig { returns(T.nilable(Time)) } + attr_accessor :applied_at + + # When this change was cancelled. + sig { returns(T.nilable(Time)) } + attr_accessor :cancelled_at + + # A subscription change represents a desired new subscription / pending change to + # an existing subscription. It is a way to first preview the effects on the + # subscription as well as any changes/creation of invoices (see + # `subscription.changed_resources`). + sig do + params( + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeRetrieveResponse::Status::OrSymbol, + subscription: T.nilable(T.any(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription, Orb::Internal::AnyHash)), + applied_at: T.nilable(Time), + cancelled_at: T.nilable(Time) + ) + .returns(T.attached_class) + end + def self.new(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil); end + + sig do + override + .returns( + { + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol, + subscription: T.nilable(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription), + applied_at: T.nilable(Time), + cancelled_at: T.nilable(Time) + } + ) + end + def to_hash; end + + module Status + extend Orb::Internal::Type::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol) } + + PENDING = T.let(:pending, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol) + APPLIED = T.let(:applied, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol) + CANCELLED = T.let(:cancelled, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol) + + sig { override.returns(T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol]) } + def self.values; end + end + + class Subscription < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # The current plan phase that is active, only if the subscription's plan has + # phases. + sig { returns(T.nilable(Integer)) } + attr_accessor :active_plan_phase_order + + # The adjustment intervals for this subscription sorted by the start_date of the + # adjustment interval. + sig { returns(T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval]) } + attr_accessor :adjustment_intervals + + # Determines whether issued invoices for this subscription will automatically be + # charged with the saved payment method on the due date. This property defaults to + # the plan's behavior. If null, defaults to the customer's setting. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :auto_collection + + sig { returns(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration) } + attr_reader :billing_cycle_anchor_configuration + + sig do + params( + billing_cycle_anchor_configuration: T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration, + Orb::Internal::AnyHash + ) + ) + .void + end + attr_writer :billing_cycle_anchor_configuration + + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + sig { returns(Integer) } + attr_accessor :billing_cycle_day + + sig { returns(Time) } + attr_accessor :created_at + + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is not part of the billing period. Set to null for + # subscriptions that are not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_end_date + + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if the subscription is not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_start_date + + # A customer is a buyer of your products, and the other party to the billing + # relationship. + # + # In Orb, customers are assigned system generated identifiers automatically, but + # it's often desirable to have these match existing identifiers in your system. To + # avoid having to denormalize Orb ID information, you can pass in an + # `external_customer_id` with your own identifier. See + # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further + # information about how these aliases work in Orb. + # + # In addition to having an identifier in your system, a customer may exist in a + # payment provider solution like Stripe. Use the `payment_provider_id` and the + # `payment_provider` enum field to express this mapping. + # + # A customer also has a timezone (from the standard + # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to + # your account's timezone. See [Timezone localization](/essentials/timezones) for + # information on what this timezone parameter influences within Orb. + sig { returns(Orb::Models::Customer) } + attr_reader :customer + + sig { params(customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash)).void } + attr_writer :customer + + # Determines the default memo on this subscriptions' invoices. Note that if this + # is not provided, it is determined by the plan configuration. + sig { returns(T.nilable(String)) } + attr_accessor :default_invoice_memo + + # The discount intervals for this subscription sorted by the start_date. + sig do + returns( + T::Array[ + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval + ) + ] + ) + end + attr_accessor :discount_intervals + + # The date Orb stops billing for this subscription. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { returns(T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule]) } + attr_accessor :fixed_fee_quantity_schedule + + sig { returns(T.nilable(String)) } + attr_accessor :invoicing_threshold + + # The maximum intervals for this subscription sorted by the start_date. + sig { returns(T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval]) } + attr_accessor :maximum_intervals + + # User specified key-value pairs for the resource. If not present, this defaults + # to an empty dictionary. Individual keys can be removed by setting the value to + # `null`, and the entire metadata mapping can be cleared by setting `metadata` to + # `null`. + sig { returns(T::Hash[Symbol, String]) } + attr_accessor :metadata + + # The minimum intervals for this subscription sorted by the start_date. + sig { returns(T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval]) } + attr_accessor :minimum_intervals + + # Determines the difference between the invoice issue date for subscription + # invoices as the date that they are due. A value of `0` here represents that the + # invoice is due on issue, whereas a value of `30` represents that the customer + # has a month to pay the invoice. + sig { returns(Integer) } + attr_accessor :net_terms + + # A pending subscription change if one exists on this subscription. + sig do + returns( + T.nilable(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange) + ) + end + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :pending_subscription_change + + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be + # subscribed to by a customer. Plans define the billing behavior of the + # subscription. You can see more about how to configure prices in the + # [Price resource](/reference/price). + sig { returns(Orb::Models::Plan) } + attr_reader :plan + + sig { params(plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash)).void } + attr_writer :plan + + # The price intervals for this subscription. + sig { returns(T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval]) } + attr_accessor :price_intervals + + sig { returns(T.nilable(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon)) } + attr_reader :redeemed_coupon + + sig do + params( + redeemed_coupon: T.nilable( + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :redeemed_coupon + + # The date Orb starts billing for this subscription. + sig { returns(Time) } + attr_accessor :start_date + + sig { returns(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol) } + attr_accessor :status + + sig { returns(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo) } + attr_reader :trial_info + + sig do + params( + trial_info: T.any(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo, Orb::Internal::AnyHash) + ) + .void + end + attr_writer :trial_info + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :changed_resources + + sig do + params( + id: String, + active_plan_phase_order: T.nilable(Integer), + adjustment_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval, + Orb::Internal::AnyHash + ) + ], + auto_collection: T.nilable(T::Boolean), + billing_cycle_anchor_configuration: T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration, + Orb::Internal::AnyHash + ), + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash), + default_invoice_memo: T.nilable(String), + discount_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval + ) + ], + end_date: T.nilable(Time), + fixed_fee_quantity_schedule: T::Array[ + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule, + Orb::Internal::AnyHash + ) + ], + invoicing_threshold: T.nilable(String), + maximum_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval, + Orb::Internal::AnyHash + ) + ], + metadata: T::Hash[Symbol, String], + minimum_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval, + Orb::Internal::AnyHash + ) + ], + net_terms: Integer, + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ), + plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), + price_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval, + Orb::Internal::AnyHash + ) + ], + redeemed_coupon: T.nilable( + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon, + Orb::Internal::AnyHash + ) + ), + start_date: Time, + status: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::OrSymbol, + trial_info: T.any(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources, + Orb::Internal::AnyHash + ) + ) + ) + .returns(T.attached_class) + end + def self.new( + id:, + active_plan_phase_order:, + adjustment_intervals:, + auto_collection:, + billing_cycle_anchor_configuration:, + billing_cycle_day:, + created_at:, + current_billing_period_end_date:, + current_billing_period_start_date:, + customer:, + default_invoice_memo:, + discount_intervals:, + end_date:, + fixed_fee_quantity_schedule:, + invoicing_threshold:, + maximum_intervals:, + metadata:, + minimum_intervals:, + net_terms:, + pending_subscription_change:, + plan:, + price_intervals:, + redeemed_coupon:, + start_date:, + status:, + trial_info:, + changed_resources: nil + ); end + sig do + override + .returns( + { + id: String, + active_plan_phase_order: T.nilable(Integer), + adjustment_intervals: T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval], + auto_collection: T.nilable(T::Boolean), + billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + customer: Orb::Models::Customer, + default_invoice_memo: T.nilable(String), + discount_intervals: T::Array[ + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval + ) + ], + end_date: T.nilable(Time), + fixed_fee_quantity_schedule: T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule], + invoicing_threshold: T.nilable(String), + maximum_intervals: T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval], + metadata: T::Hash[Symbol, String], + minimum_intervals: T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval], + net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange), + plan: Orb::Models::Plan, + price_intervals: T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval], + redeemed_coupon: T.nilable(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon), + start_date: Time, + status: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol, + trial_info: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources) + } + ) + end + def to_hash; end + + class AdjustmentInterval < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig do + returns( + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + ) + ) + end + attr_accessor :adjustment + + # The price interval IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + # The end date of the adjustment interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The start date of the adjustment interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + id: String, + adjustment: T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Internal::AnyHash, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + ), + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time + ) + .returns(T.attached_class) + end + def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end + + sig do + override + .returns( + { + id: String, + adjustment: T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + ), + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time + } + ) + end + def to_hash; end + + module Adjustment + extend Orb::Internal::Type::Union + + class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + # The number of usage units by which to discount the price this adjustment applies + # to in a given billing period. + sig { returns(Float) } + attr_accessor :usage_discount + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + usage_discount: Float, + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + plan_phase_order:, + reason:, + usage_discount:, + adjustment_type: :usage_discount + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + usage_discount: Float + } + ) + end + def to_hash; end + end + + class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The amount by which to discount the prices this adjustment applies to in a given + # billing period. + sig { returns(String) } + attr_accessor :amount_discount + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + amount_discount: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + amount_discount:, + applies_to_price_ids:, + is_invoice_level:, + plan_phase_order:, + reason:, + adjustment_type: :amount_discount + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + amount_discount: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The percentage (as a value between 0 and 1) by which to discount the price + # intervals this adjustment applies to in a given billing period. + sig { returns(Float) } + attr_accessor :percentage_discount + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + percentage_discount: Float, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + percentage_discount:, + plan_phase_order:, + reason:, + adjustment_type: :percentage_discount + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + percentage_discount: Float, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The item ID that revenue from this minimum will be attributed to. + sig { returns(String) } + attr_accessor :item_id + + # The minimum amount to charge in a given billing period for the prices this + # adjustment applies to. + sig { returns(String) } + attr_accessor :minimum_amount + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + item_id: String, + minimum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + item_id:, + minimum_amount:, + plan_phase_order:, + reason:, + adjustment_type: :minimum + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + item_id: String, + minimum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + sig { returns(Symbol) } + attr_accessor :adjustment_type + + # The price IDs that this adjustment applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # True for adjustments that apply to an entire invocice, false for adjustments + # that apply to only one price. + sig { returns(T::Boolean) } + attr_accessor :is_invoice_level + + # The maximum amount to charge in a given billing period for the prices this + # adjustment applies to. + sig { returns(String) } + attr_accessor :maximum_amount + + # The plan phase in which this adjustment is active. + sig { returns(T.nilable(Integer)) } + attr_accessor :plan_phase_order + + # The reason for the adjustment. + sig { returns(T.nilable(String)) } + attr_accessor :reason + + sig do + params( + id: String, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + maximum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String), + adjustment_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + id:, + applies_to_price_ids:, + is_invoice_level:, + maximum_amount:, + plan_phase_order:, + reason:, + adjustment_type: :maximum + ); end + sig do + override + .returns( + { + id: String, + adjustment_type: Symbol, + applies_to_price_ids: T::Array[String], + is_invoice_level: T::Boolean, + maximum_amount: String, + plan_phase_order: T.nilable(Integer), + reason: T.nilable(String) + } + ) + end + def to_hash; end + end + + sig do + override + .returns( + [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + ) + end + def self.variants; end + end + end + + class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel + # The day of the month on which the billing cycle is anchored. If the maximum + # number of days in a month is greater than this value, the last day of the month + # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing + # period begins on the 30th. + sig { returns(Integer) } + attr_accessor :day + + # The month on which the billing cycle is anchored (e.g. a quarterly price + # anchored in February would have cycles starting February, May, August, and + # November). + sig { returns(T.nilable(Integer)) } + attr_accessor :month + + # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle + # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.). + sig { returns(T.nilable(Integer)) } + attr_accessor :year + + sig do + params( + day: Integer, + month: T.nilable(Integer), + year: T.nilable(Integer) + ).returns(T.attached_class) + end + def self.new(day:, month: nil, year: nil); end + + sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) } + def to_hash; end + end + + module DiscountInterval + extend Orb::Internal::Type::Union + + class AmountDiscountInterval < Orb::Internal::Type::BaseModel + # Only available if discount_type is `amount`. + sig { returns(String) } + attr_accessor :amount_discount + + # The price ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + sig { returns(Symbol) } + attr_accessor :discount_type + + # The end date of the discount interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The start date of the discount interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + amount_discount: String, + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time, + discount_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + amount_discount:, + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + start_date:, + discount_type: :amount + ); end + sig do + override + .returns( + { + amount_discount: String, + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + discount_type: Symbol, + end_date: T.nilable(Time), + start_date: Time + } + ) + end + def to_hash; end + end + + class PercentageDiscountInterval < Orb::Internal::Type::BaseModel + # The price ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + sig { returns(Symbol) } + attr_accessor :discount_type + + # The end date of the discount interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # Only available if discount_type is `percentage`.This is a number between 0 + # and 1. + sig { returns(Float) } + attr_accessor :percentage_discount + + # The start date of the discount interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + percentage_discount: Float, + start_date: Time, + discount_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + percentage_discount:, + start_date:, + discount_type: :percentage + ); end + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + discount_type: Symbol, + end_date: T.nilable(Time), + percentage_discount: Float, + start_date: Time + } + ) + end + def to_hash; end + end + + class UsageDiscountInterval < Orb::Internal::Type::BaseModel + # The price ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this discount interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + sig { returns(Symbol) } + attr_accessor :discount_type + + # The end date of the discount interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The start date of the discount interval. + sig { returns(Time) } + attr_accessor :start_date + + # Only available if discount_type is `usage`. Number of usage units that this + # discount is for + sig { returns(Float) } + attr_accessor :usage_discount + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + start_date: Time, + usage_discount: Float, + discount_type: Symbol + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + start_date:, + usage_discount:, + discount_type: :usage + ); end + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + discount_type: Symbol, + end_date: T.nilable(Time), + start_date: Time, + usage_discount: Float + } + ) + end + def to_hash; end + end + + sig do + override + .returns( + [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval] + ) + end + def self.variants; end + end + + class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { returns(String) } + attr_accessor :price_id + + sig { returns(Float) } + attr_accessor :quantity + + sig { returns(Time) } + attr_accessor :start_date + + sig do + params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time) + .returns(T.attached_class) + end + def self.new(end_date:, price_id:, quantity:, start_date:); end + + sig do + override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time}) + end + def to_hash; end + end + + class MaximumInterval < Orb::Internal::Type::BaseModel + # The price ids that this maximum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this maximum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + # The end date of the maximum interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The maximum amount to charge in a given billing period for the price intervals + # this transform applies to. + sig { returns(String) } + attr_accessor :maximum_amount + + # The start date of the maximum interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + maximum_amount: String, + start_date: Time + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + maximum_amount:, + start_date: + ) + end + + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + maximum_amount: String, + start_date: Time + } + ) + end + def to_hash; end + end + + class MinimumInterval < Orb::Internal::Type::BaseModel + # The price ids that this minimum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_ids + + # The price interval ids that this minimum interval applies to. + sig { returns(T::Array[String]) } + attr_accessor :applies_to_price_interval_ids + + # The end date of the minimum interval. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # The minimum amount to charge in a given billing period for the price intervals + # this minimum applies to. + sig { returns(String) } + attr_accessor :minimum_amount + + # The start date of the minimum interval. + sig { returns(Time) } + attr_accessor :start_date + + sig do + params( + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + minimum_amount: String, + start_date: Time + ) + .returns(T.attached_class) + end + def self.new( + applies_to_price_ids:, + applies_to_price_interval_ids:, + end_date:, + minimum_amount:, + start_date: + ) + end + + sig do + override + .returns( + { + applies_to_price_ids: T::Array[String], + applies_to_price_interval_ids: T::Array[String], + end_date: T.nilable(Time), + minimum_amount: String, + start_date: Time + } + ) + end + def to_hash; end + end + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + + class PriceInterval < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # The day of the month that Orb bills for this price + sig { returns(Integer) } + attr_accessor :billing_cycle_day + + # The end of the current billing period. This is an exclusive timestamp, such that + # the instant returned is exactly the end of the billing period. Set to null if + # this price interval is not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_end_date + + # The start date of the current billing period. This is an inclusive timestamp; + # the instant returned is exactly the beginning of the billing period. Set to null + # if this price interval is not currently active. + sig { returns(T.nilable(Time)) } + attr_accessor :current_billing_period_start_date + + # The end date of the price interval. This is the date that Orb stops billing for + # this price. + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + # An additional filter to apply to usage queries. + sig { returns(T.nilable(String)) } + attr_accessor :filter + + # The fixed fee quantity transitions for this price interval. This is only + # relevant for fixed fees. + sig do + returns( + T.nilable( + T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] + ) + ) + end + attr_accessor :fixed_fee_quantity_transitions + + # The Price resource represents a price that can be billed on a subscription, + # resulting in a charge on an invoice in the form of an invoice line item. Prices + # take a quantity and determine an amount to bill. + # + # Orb supports a few different pricing models out of the box. Each of these models + # is serialized differently in a given Price object. The model_type field + # determines the key for the configuration object that is present. + # + # For more on the types of prices, see + # [the core concepts documentation](/core-concepts#plan-and-price) + sig do + returns( + T.any( + Orb::Models::Price::UnitPrice, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ) + ) + end + attr_accessor :price + + # The start date of the price interval. This is the date that Orb starts billing + # for this price. + sig { returns(Time) } + attr_accessor :start_date + + # A list of customer IDs whose usage events will be aggregated and billed under + # this price interval. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :usage_customer_ids + + # The Price Interval resource represents a period of time for which a price will + # bill on a subscription. A subscription’s price intervals define its billing + # behavior. + sig do + params( + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + end_date: T.nilable(Time), + filter: T.nilable(String), + fixed_fee_quantity_transitions: T.nilable( + T::Array[ + T.any( + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition, + Orb::Internal::AnyHash + ) + ] + ), + price: T.any( + Orb::Models::Price::UnitPrice, + Orb::Internal::AnyHash, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ), + start_date: Time, + usage_customer_ids: T.nilable(T::Array[String]) + ) + .returns(T.attached_class) + end + def self.new( + id:, + billing_cycle_day:, + current_billing_period_end_date:, + current_billing_period_start_date:, + end_date:, + filter:, + fixed_fee_quantity_transitions:, + price:, + start_date:, + usage_customer_ids: + ); end + sig do + override + .returns( + { + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: T.nilable(Time), + current_billing_period_start_date: T.nilable(Time), + end_date: T.nilable(Time), + filter: T.nilable(String), + fixed_fee_quantity_transitions: T.nilable( + T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] + ), + price: T.any( + Orb::Models::Price::UnitPrice, + Orb::Models::Price::PackagePrice, + Orb::Models::Price::MatrixPrice, + Orb::Models::Price::TieredPrice, + Orb::Models::Price::TieredBpsPrice, + Orb::Models::Price::BpsPrice, + Orb::Models::Price::BulkBpsPrice, + Orb::Models::Price::BulkPrice, + Orb::Models::Price::ThresholdTotalAmountPrice, + Orb::Models::Price::TieredPackagePrice, + Orb::Models::Price::GroupedTieredPrice, + Orb::Models::Price::TieredWithMinimumPrice, + Orb::Models::Price::TieredPackageWithMinimumPrice, + Orb::Models::Price::PackageWithAllocationPrice, + Orb::Models::Price::UnitWithPercentPrice, + Orb::Models::Price::MatrixWithAllocationPrice, + Orb::Models::Price::TieredWithProrationPrice, + Orb::Models::Price::UnitWithProrationPrice, + Orb::Models::Price::GroupedAllocationPrice, + Orb::Models::Price::GroupedWithProratedMinimumPrice, + Orb::Models::Price::GroupedWithMeteredMinimumPrice, + Orb::Models::Price::MatrixWithDisplayNamePrice, + Orb::Models::Price::BulkWithProrationPrice, + Orb::Models::Price::GroupedTieredPackagePrice, + Orb::Models::Price::MaxGroupTieredPackagePrice, + Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, + Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, + Orb::Models::Price::CumulativeGroupedBulkPrice + ), + start_date: Time, + usage_customer_ids: T.nilable(T::Array[String]) + } + ) + end + def to_hash; end + + class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel + sig { returns(Time) } + attr_accessor :effective_date + + sig { returns(String) } + attr_accessor :price_id + + sig { returns(Integer) } + attr_accessor :quantity + + sig do + params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) + end + def self.new(effective_date:, price_id:, quantity:); end + + sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) } + def to_hash; end + end + end + + class RedeemedCoupon < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :coupon_id + + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { returns(Time) } + attr_accessor :start_date + + sig do + params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class) + end + def self.new(coupon_id:, end_date:, start_date:); end + + sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) } + def to_hash; end + end + + module Status + extend Orb::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol) } + + ACTIVE = + T.let(:active, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol) + ENDED = + T.let(:ended, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol) + UPCOMING = + T.let(:upcoming, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol) + + sig do + override + .returns(T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol]) + end + def self.values; end + end + + class TrialInfo < Orb::Internal::Type::BaseModel + sig { returns(T.nilable(Time)) } + attr_accessor :end_date + + sig { params(end_date: T.nilable(Time)).returns(T.attached_class) } + def self.new(end_date:); end + + sig { override.returns({end_date: T.nilable(Time)}) } + def to_hash; end + end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end + end + end + end +end diff --git a/rbi/lib/orb/models/subscription_create_params.rbi b/rbi/lib/orb/models/subscription_create_params.rbi index b25f1452..db6ad2a6 100644 --- a/rbi/lib/orb/models/subscription_create_params.rbi +++ b/rbi/lib/orb/models/subscription_create_params.rbi @@ -2608,7 +2608,7 @@ module Orb def to_hash; end class Tier < Orb::Internal::Type::BaseModel - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(Float) } attr_accessor :first_unit @@ -2616,7 +2616,7 @@ module Orb sig { returns(String) } attr_accessor :unit_amount - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier sig { returns(T.nilable(Float)) } attr_accessor :last_unit @@ -3098,11 +3098,11 @@ module Orb sig { returns(Float) } attr_accessor :bps - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(String) } attr_accessor :minimum_amount - # Exclusive tier ending value + # Inclusive tier ending value sig { returns(T.nilable(String)) } attr_accessor :maximum_amount @@ -13925,7 +13925,7 @@ module Orb def to_hash; end class Tier < Orb::Internal::Type::BaseModel - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(Float) } attr_accessor :first_unit @@ -13933,7 +13933,7 @@ module Orb sig { returns(String) } attr_accessor :unit_amount - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier sig { returns(T.nilable(Float)) } attr_accessor :last_unit @@ -14415,11 +14415,11 @@ module Orb sig { returns(Float) } attr_accessor :bps - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(String) } attr_accessor :minimum_amount - # Exclusive tier ending value + # Inclusive tier ending value sig { returns(T.nilable(String)) } attr_accessor :maximum_amount diff --git a/rbi/lib/orb/models/subscription_create_response.rbi b/rbi/lib/orb/models/subscription_create_response.rbi index 8827da97..f1ba0428 100644 --- a/rbi/lib/orb/models/subscription_create_response.rbi +++ b/rbi/lib/orb/models/subscription_create_response.rbi @@ -130,6 +130,20 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -168,6 +182,20 @@ module Orb sig { params(trial_info: T.any(Orb::Models::SubscriptionCreateResponse::TrialInfo, Orb::Internal::AnyHash)).void } attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionCreateResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable(T.any(Orb::Models::SubscriptionCreateResponse::ChangedResources, Orb::Internal::AnyHash)) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -196,12 +224,16 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionCreateResponse::MinimumInterval, Orb::Internal::AnyHash)], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[T.any(Orb::Models::SubscriptionCreateResponse::PriceInterval, Orb::Internal::AnyHash)], redeemed_coupon: T.nilable(T.any(Orb::Models::SubscriptionCreateResponse::RedeemedCoupon, Orb::Internal::AnyHash)), start_date: Time, status: Orb::Models::SubscriptionCreateResponse::Status::OrSymbol, - trial_info: T.any(Orb::Models::SubscriptionCreateResponse::TrialInfo, Orb::Internal::AnyHash) + trial_info: T.any(Orb::Models::SubscriptionCreateResponse::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable(T.any(Orb::Models::SubscriptionCreateResponse::ChangedResources, Orb::Internal::AnyHash)) ) .returns(T.attached_class) end @@ -225,12 +257,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -261,12 +295,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionCreateResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionCreateResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionCreateResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionCreateResponse::TrialInfo + trial_info: Orb::Models::SubscriptionCreateResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionCreateResponse::ChangedResources) } ) end @@ -1051,6 +1087,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1322,6 +1370,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/models/subscription_price_intervals_params.rbi b/rbi/lib/orb/models/subscription_price_intervals_params.rbi index 494ceead..82716f0b 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_params.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_params.rbi @@ -2628,7 +2628,7 @@ module Orb def to_hash; end class Tier < Orb::Internal::Type::BaseModel - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(Float) } attr_accessor :first_unit @@ -2636,7 +2636,7 @@ module Orb sig { returns(String) } attr_accessor :unit_amount - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier sig { returns(T.nilable(Float)) } attr_accessor :last_unit @@ -3109,11 +3109,11 @@ module Orb sig { returns(Float) } attr_accessor :bps - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(String) } attr_accessor :minimum_amount - # Exclusive tier ending value + # Inclusive tier ending value sig { returns(T.nilable(String)) } attr_accessor :maximum_amount diff --git a/rbi/lib/orb/models/subscription_price_intervals_response.rbi b/rbi/lib/orb/models/subscription_price_intervals_response.rbi index 74946de1..6552034c 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_response.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_response.rbi @@ -133,6 +133,20 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -176,6 +190,22 @@ module Orb end attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable( + T.any(Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -207,12 +237,18 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval, Orb::Internal::AnyHash)], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[T.any(Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval, Orb::Internal::AnyHash)], redeemed_coupon: T.nilable(T.any(Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon, Orb::Internal::AnyHash)), start_date: Time, status: Orb::Models::SubscriptionPriceIntervalsResponse::Status::OrSymbol, - trial_info: T.any(Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo, Orb::Internal::AnyHash) + trial_info: T.any(Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable( + T.any(Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources, Orb::Internal::AnyHash) + ) ) .returns(T.attached_class) end @@ -236,12 +272,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -272,12 +310,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo + trial_info: Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources) } ) end @@ -1062,6 +1102,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1337,6 +1389,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi b/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi index e615d5a9..f2b807e1 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi @@ -2684,7 +2684,7 @@ module Orb def to_hash; end class Tier < Orb::Internal::Type::BaseModel - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(Float) } attr_accessor :first_unit @@ -2692,7 +2692,7 @@ module Orb sig { returns(String) } attr_accessor :unit_amount - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier sig { returns(T.nilable(Float)) } attr_accessor :last_unit @@ -3174,11 +3174,11 @@ module Orb sig { returns(Float) } attr_accessor :bps - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(String) } attr_accessor :minimum_amount - # Exclusive tier ending value + # Inclusive tier ending value sig { returns(T.nilable(String)) } attr_accessor :maximum_amount @@ -14073,7 +14073,7 @@ module Orb def to_hash; end class Tier < Orb::Internal::Type::BaseModel - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(Float) } attr_accessor :first_unit @@ -14081,7 +14081,7 @@ module Orb sig { returns(String) } attr_accessor :unit_amount - # Exclusive tier ending value. If null, this is treated as the last tier + # Inclusive tier ending value. If null, this is treated as the last tier sig { returns(T.nilable(Float)) } attr_accessor :last_unit @@ -14563,11 +14563,11 @@ module Orb sig { returns(Float) } attr_accessor :bps - # Inclusive tier starting value + # Exclusive tier starting value sig { returns(String) } attr_accessor :minimum_amount - # Exclusive tier ending value + # Inclusive tier ending value sig { returns(T.nilable(String)) } attr_accessor :maximum_amount diff --git a/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi b/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi index 1a85c417..c4947a04 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi @@ -133,6 +133,23 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -178,6 +195,22 @@ module Orb end attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable( + T.any(Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -214,6 +247,12 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval, Orb::Internal::AnyHash)], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[T.any(Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval, Orb::Internal::AnyHash)], redeemed_coupon: T.nilable( @@ -221,7 +260,10 @@ module Orb ), start_date: Time, status: Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::OrSymbol, - trial_info: T.any(Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo, Orb::Internal::AnyHash) + trial_info: T.any(Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable( + T.any(Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources, Orb::Internal::AnyHash) + ) ) .returns(T.attached_class) end @@ -245,12 +287,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -281,12 +325,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo + trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources) } ) end @@ -1071,6 +1117,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1347,6 +1405,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi index ed64d133..83e42ed1 100644 --- a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +++ b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi @@ -133,6 +133,20 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -176,6 +190,20 @@ module Orb end attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable(T.any(Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources, Orb::Internal::AnyHash)) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -207,12 +235,16 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval, Orb::Internal::AnyHash)], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[T.any(Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval, Orb::Internal::AnyHash)], redeemed_coupon: T.nilable(T.any(Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon, Orb::Internal::AnyHash)), start_date: Time, status: Orb::Models::SubscriptionTriggerPhaseResponse::Status::OrSymbol, - trial_info: T.any(Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo, Orb::Internal::AnyHash) + trial_info: T.any(Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable(T.any(Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources, Orb::Internal::AnyHash)) ) .returns(T.attached_class) end @@ -236,12 +268,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -272,12 +306,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo + trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources) } ) end @@ -1062,6 +1098,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1337,6 +1385,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi index a19fe995..7fac191d 100644 --- a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi @@ -133,6 +133,23 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -178,6 +195,22 @@ module Orb end attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable( + T.any(Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -214,6 +247,12 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionUnscheduleCancellationResponse::MinimumInterval, Orb::Internal::AnyHash)], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[T.any(Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval, Orb::Internal::AnyHash)], redeemed_coupon: T.nilable( @@ -221,7 +260,10 @@ module Orb ), start_date: Time, status: Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::OrSymbol, - trial_info: T.any(Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo, Orb::Internal::AnyHash) + trial_info: T.any(Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable( + T.any(Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources, Orb::Internal::AnyHash) + ) ) .returns(T.attached_class) end @@ -245,12 +287,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -281,12 +325,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionUnscheduleCancellationResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources) } ) end @@ -1071,6 +1117,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1348,6 +1406,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi index c4f9d2e8..e081093f 100644 --- a/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi @@ -141,6 +141,27 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig do + returns( + T.nilable(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange) + ) + end + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -192,6 +213,25 @@ module Orb end attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -243,6 +283,12 @@ module Orb ) ], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[ T.any( @@ -261,6 +307,12 @@ module Orb trial_info: T.any( Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo, Orb::Internal::AnyHash + ), + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources, + Orb::Internal::AnyHash + ) ) ) .returns(T.attached_class) @@ -285,12 +337,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -321,12 +375,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources) } ) end @@ -1111,6 +1167,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1405,6 +1473,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi index 5ff1c4b9..4024ef64 100644 --- a/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi @@ -133,6 +133,27 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig do + returns( + T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange) + ) + end + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -181,6 +202,25 @@ module Orb end attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -232,6 +272,12 @@ module Orb ) ], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[ T.any( @@ -247,7 +293,13 @@ module Orb ), start_date: Time, status: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::OrSymbol, - trial_info: T.any(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo, Orb::Internal::AnyHash) + trial_info: T.any(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable( + T.any( + Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources, + Orb::Internal::AnyHash + ) + ) ) .returns(T.attached_class) end @@ -271,12 +323,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -307,12 +361,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources) } ) end @@ -1097,6 +1153,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1379,6 +1447,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi index e21c6666..950a33ca 100644 --- a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +++ b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi @@ -133,6 +133,23 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -178,6 +195,22 @@ module Orb end attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable( + T.any(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -214,6 +247,12 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval, Orb::Internal::AnyHash)], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any( + Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange, + Orb::Internal::AnyHash + ) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[T.any(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval, Orb::Internal::AnyHash)], redeemed_coupon: T.nilable( @@ -221,7 +260,10 @@ module Orb ), start_date: Time, status: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::OrSymbol, - trial_info: T.any(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo, Orb::Internal::AnyHash) + trial_info: T.any(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable( + T.any(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources, Orb::Internal::AnyHash) + ) ) .returns(T.attached_class) end @@ -245,12 +287,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -281,12 +325,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources) } ) end @@ -1071,6 +1117,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1348,6 +1406,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/models/subscription_update_trial_response.rbi b/rbi/lib/orb/models/subscription_update_trial_response.rbi index 912d47b5..021652a7 100644 --- a/rbi/lib/orb/models/subscription_update_trial_response.rbi +++ b/rbi/lib/orb/models/subscription_update_trial_response.rbi @@ -133,6 +133,20 @@ module Orb sig { returns(Integer) } attr_accessor :net_terms + # A pending subscription change if one exists on this subscription. + sig { returns(T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange)) } + attr_reader :pending_subscription_change + + sig do + params( + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ) + ) + .void + end + attr_writer :pending_subscription_change + # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be # subscribed to by a customer. Plans define the billing behavior of the # subscription. You can see more about how to configure prices in the @@ -174,6 +188,20 @@ module Orb end attr_writer :trial_info + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig { returns(T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources)) } + attr_reader :changed_resources + + sig do + params( + changed_resources: T.nilable(T.any(Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, Orb::Internal::AnyHash)) + ) + .void + end + attr_writer :changed_resources + sig do params( id: String, @@ -205,12 +233,16 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[T.any(Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval, Orb::Internal::AnyHash)], net_terms: Integer, + pending_subscription_change: T.nilable( + T.any(Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, Orb::Internal::AnyHash) + ), plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash), price_intervals: T::Array[T.any(Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval, Orb::Internal::AnyHash)], redeemed_coupon: T.nilable(T.any(Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon, Orb::Internal::AnyHash)), start_date: Time, status: Orb::Models::SubscriptionUpdateTrialResponse::Status::OrSymbol, - trial_info: T.any(Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo, Orb::Internal::AnyHash) + trial_info: T.any(Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo, Orb::Internal::AnyHash), + changed_resources: T.nilable(T.any(Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources, Orb::Internal::AnyHash)) ) .returns(T.attached_class) end @@ -234,12 +266,14 @@ module Orb metadata:, minimum_intervals:, net_terms:, + pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, - trial_info: + trial_info:, + changed_resources: nil ); end sig do override @@ -270,12 +304,14 @@ module Orb metadata: T::Hash[Symbol, String], minimum_intervals: T::Array[Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange), plan: Orb::Models::Plan, price_intervals: T::Array[Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval], redeemed_coupon: T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon), start_date: Time, status: Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol, - trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo, + changed_resources: T.nilable(Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources) } ) end @@ -1060,6 +1096,18 @@ module Orb def to_hash; end end + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + sig { returns(String) } + attr_accessor :id + + # A pending subscription change if one exists on this subscription. + sig { params(id: String).returns(T.attached_class) } + def self.new(id:); end + + sig { override.returns({id: String}) } + def to_hash; end + end + class PriceInterval < Orb::Internal::Type::BaseModel sig { returns(String) } attr_accessor :id @@ -1335,6 +1383,51 @@ module Orb sig { override.returns({end_date: T.nilable(Time)}) } def to_hash; end end + + class ChangedResources < Orb::Internal::Type::BaseModel + # The credit notes that were created as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :created_credit_notes + + # The invoices that were created as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :created_invoices + + # The credit notes that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::CreditNote]) } + attr_accessor :voided_credit_notes + + # The invoices that were voided as part of this operation. + sig { returns(T::Array[Orb::Models::Invoice]) } + attr_accessor :voided_invoices + + # The resources that were changed as part of this operation. Only present when + # fetched through the subscription changes API or if the + # `include_changed_resources` parameter was passed in the request. + sig do + params( + created_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + created_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)], + voided_credit_notes: T::Array[T.any(Orb::Models::CreditNote, Orb::Internal::AnyHash)], + voided_invoices: T::Array[T.any(Orb::Models::Invoice, Orb::Internal::AnyHash)] + ) + .returns(T.attached_class) + end + def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end + + sig do + override + .returns( + { + created_credit_notes: T::Array[Orb::Models::CreditNote], + created_invoices: T::Array[Orb::Models::Invoice], + voided_credit_notes: T::Array[Orb::Models::CreditNote], + voided_invoices: T::Array[Orb::Models::Invoice] + } + ) + end + def to_hash; end + end end end end diff --git a/rbi/lib/orb/resources/invoices.rbi b/rbi/lib/orb/resources/invoices.rbi index 777389e9..e5cc8afe 100644 --- a/rbi/lib/orb/resources/invoices.rbi +++ b/rbi/lib/orb/resources/invoices.rbi @@ -55,8 +55,9 @@ module Orb # by setting the value to `null`, and the entire metadata mapping can be cleared # by setting `metadata` to `null`. metadata: nil, - # When true, this invoice will automatically be issued upon creation. When false, - # the resulting invoice will require manual review to issue. Defaulted to false. + # When true, this invoice will be submitted for issuance upon creation. When + # false, the resulting invoice will require manual review to issue. Defaulted to + # false. will_auto_issue: nil, request_options: {} ); end diff --git a/rbi/lib/orb/resources/subscription_changes.rbi b/rbi/lib/orb/resources/subscription_changes.rbi new file mode 100644 index 00000000..c6ae110a --- /dev/null +++ b/rbi/lib/orb/resources/subscription_changes.rbi @@ -0,0 +1,61 @@ +# typed: strong + +module Orb + module Resources + class SubscriptionChanges + # This endpoint returns a subscription change given an identifier. + # + # A subscription change is created by including + # `Create-Pending-Subscription-Change: True` in the header of a subscription + # mutation API call (e.g. + # [create subscription endpoint](/api-reference/subscription/create-subscription), + # [schedule plan change endpoint](/api-reference/subscription/schedule-plan-change), + # ...). The subscription change will be referenced by the + # `pending_subscription_change` field in the response. + sig do + params( + subscription_change_id: String, + request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) + ) + .returns(Orb::Models::SubscriptionChangeRetrieveResponse) + end + def retrieve(subscription_change_id, request_options: {}); end + + # Apply a subscription change to perform the intended action. If a positive amount + # is passed with a request to this endpoint, any eligible invoices that were + # created will be issued immediately if they only contain in-advance fees. + sig do + params( + subscription_change_id: String, + description: T.nilable(String), + previously_collected_amount: T.nilable(String), + request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) + ) + .returns(Orb::Models::SubscriptionChangeApplyResponse) + end + def apply( + subscription_change_id, + # Description to apply to the balance transaction representing this credit. + description: nil, + # Amount already collected to apply to the customer's balance. + previously_collected_amount: nil, + request_options: {} + ); end + # Cancel a subscription change. The change can no longer be applied. A + # subscription can only have one "pending" change at a time - use this endpoint to + # cancel an existing change before creating a new one. + sig do + params( + subscription_change_id: String, + request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash)) + ) + .returns(Orb::Models::SubscriptionChangeCancelResponse) + end + def cancel(subscription_change_id, request_options: {}); end + + # @api private + sig { params(client: Orb::Client).returns(T.attached_class) } + def self.new(client:); end + end + end +end diff --git a/sig/orb/client.rbs b/sig/orb/client.rbs index 3ace7220..6e9f8206 100644 --- a/sig/orb/client.rbs +++ b/sig/orb/client.rbs @@ -38,6 +38,8 @@ module Orb attr_reader dimensional_price_groups: Orb::Resources::DimensionalPriceGroups + attr_reader subscription_changes: Orb::Resources::SubscriptionChanges + private def auth_headers: -> ::Hash[String, String] def initialize: ( diff --git a/sig/orb/models/subscription.rbs b/sig/orb/models/subscription.rbs index aae87750..b7ee312d 100644 --- a/sig/orb/models/subscription.rbs +++ b/sig/orb/models/subscription.rbs @@ -21,6 +21,7 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::Subscription::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::Subscription::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::Subscription::PriceInterval], redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon?, @@ -68,6 +69,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::Subscription::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::Subscription::PriceInterval] @@ -100,6 +103,7 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::Subscription::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::Subscription::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::Subscription::PriceInterval], redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon?, @@ -572,6 +576,16 @@ module Orb def to_hash: -> Orb::Models::Subscription::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::Subscription::pending_subscription_change + end + type price_interval = { id: String, diff --git a/sig/orb/models/subscription_cancel_response.rbs b/sig/orb/models/subscription_cancel_response.rbs index c5418431..2e932e31 100644 --- a/sig/orb/models/subscription_cancel_response.rbs +++ b/sig/orb/models/subscription_cancel_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionCancelResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionCancelResponse::status, - trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo + trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionCancelResponse::ChangedResources? } class SubscriptionCancelResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionCancelResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionCancelResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionCancelResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionCancelResponse::status, - trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo + trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionCancelResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_cancel_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionCancelResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionCancelResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionCancelResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionCancelResponse::changed_resources + end end end end diff --git a/sig/orb/models/subscription_change_apply_params.rbs b/sig/orb/models/subscription_change_apply_params.rbs new file mode 100644 index 00000000..b358187e --- /dev/null +++ b/sig/orb/models/subscription_change_apply_params.rbs @@ -0,0 +1,24 @@ +module Orb + module Models + type subscription_change_apply_params = + { description: String?, previously_collected_amount: String? } + & Orb::Internal::Type::request_parameters + + class SubscriptionChangeApplyParams < Orb::Internal::Type::BaseModel + extend Orb::Internal::Type::RequestParameters::Converter + include Orb::Internal::Type::RequestParameters + + attr_accessor description: String? + + attr_accessor previously_collected_amount: String? + + def initialize: ( + ?description: String?, + ?previously_collected_amount: String?, + ?request_options: Orb::request_opts + ) -> void + + def to_hash: -> Orb::Models::subscription_change_apply_params + end + end +end diff --git a/sig/orb/models/subscription_change_apply_response.rbs b/sig/orb/models/subscription_change_apply_response.rbs new file mode 100644 index 00000000..64de9c71 --- /dev/null +++ b/sig/orb/models/subscription_change_apply_response.rbs @@ -0,0 +1,784 @@ +module Orb + module Models + type subscription_change_apply_response = + { + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeApplyResponse::status, + subscription: Orb::Models::SubscriptionChangeApplyResponse::Subscription?, + applied_at: Time?, + cancelled_at: Time? + } + + class SubscriptionChangeApplyResponse < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor expiration_time: Time + + attr_accessor status: Orb::Models::SubscriptionChangeApplyResponse::status + + attr_accessor subscription: Orb::Models::SubscriptionChangeApplyResponse::Subscription? + + attr_accessor applied_at: Time? + + attr_accessor cancelled_at: Time? + + def initialize: ( + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeApplyResponse::status, + subscription: Orb::Models::SubscriptionChangeApplyResponse::Subscription?, + ?applied_at: Time?, + ?cancelled_at: Time? + ) -> void + + def to_hash: -> Orb::Models::subscription_change_apply_response + + type status = :pending | :applied | :cancelled + + module Status + extend Orb::Internal::Type::Enum + + PENDING: :pending + APPLIED: :applied + CANCELLED: :cancelled + + def self?.values: -> ::Array[Orb::Models::SubscriptionChangeApplyResponse::status] + end + + type subscription = + { + id: String, + active_plan_phase_order: Integer?, + adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval], + auto_collection: bool?, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + customer: Orb::Models::Customer, + default_invoice_memo: String?, + discount_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::discount_interval], + end_date: Time?, + fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::FixedFeeQuantitySchedule], + invoicing_threshold: String?, + maximum_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval], + metadata: ::Hash[Symbol, String], + minimum_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval], + net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange?, + plan: Orb::Models::Plan, + price_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval], + redeemed_coupon: Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon?, + start_date: Time, + status: Orb::Models::SubscriptionChangeApplyResponse::Subscription::status, + trial_info: Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo, + changed_resources: Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources? + } + + class Subscription < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor active_plan_phase_order: Integer? + + attr_accessor adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval] + + attr_accessor auto_collection: bool? + + attr_accessor billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration + + attr_accessor billing_cycle_day: Integer + + attr_accessor created_at: Time + + attr_accessor current_billing_period_end_date: Time? + + attr_accessor current_billing_period_start_date: Time? + + attr_accessor customer: Orb::Models::Customer + + attr_accessor default_invoice_memo: String? + + attr_accessor discount_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::discount_interval] + + attr_accessor end_date: Time? + + attr_accessor fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::FixedFeeQuantitySchedule] + + attr_accessor invoicing_threshold: String? + + attr_accessor maximum_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval] + + attr_accessor metadata: ::Hash[Symbol, String] + + attr_accessor minimum_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval] + + attr_accessor net_terms: Integer + + attr_accessor pending_subscription_change: Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange? + + attr_accessor plan: Orb::Models::Plan + + attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval] + + attr_accessor redeemed_coupon: Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon? + + attr_accessor start_date: Time + + attr_accessor status: Orb::Models::SubscriptionChangeApplyResponse::Subscription::status + + attr_accessor trial_info: Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo + + attr_accessor changed_resources: Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources? + + def initialize: ( + id: String, + active_plan_phase_order: Integer?, + adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval], + auto_collection: bool?, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeApplyResponse::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + customer: Orb::Models::Customer, + default_invoice_memo: String?, + discount_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::discount_interval], + end_date: Time?, + fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::FixedFeeQuantitySchedule], + invoicing_threshold: String?, + maximum_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MaximumInterval], + metadata: ::Hash[Symbol, String], + minimum_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::MinimumInterval], + net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionChangeApplyResponse::Subscription::PendingSubscriptionChange?, + plan: Orb::Models::Plan, + price_intervals: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval], + redeemed_coupon: Orb::Models::SubscriptionChangeApplyResponse::Subscription::RedeemedCoupon?, + start_date: Time, + status: Orb::Models::SubscriptionChangeApplyResponse::Subscription::status, + trial_info: Orb::Models::SubscriptionChangeApplyResponse::Subscription::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionChangeApplyResponse::Subscription::ChangedResources? + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::subscription + + type adjustment_interval = + { + id: String, + adjustment: Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::adjustment, + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time + } + + class AdjustmentInterval < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment: Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::adjustment + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + def initialize: ( + id: String, + adjustment: Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::adjustment, + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::adjustment_interval + + type adjustment = + Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment + | Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment + | Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment + | Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment + | Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + + module Adjustment + extend Orb::Internal::Type::Union + + type plan_phase_usage_discount_adjustment = + { + id: String, + adjustment_type: :usage_discount, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String?, + usage_discount: Float + } + + class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :usage_discount + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + attr_accessor usage_discount: Float + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String?, + usage_discount: Float, + ?adjustment_type: :usage_discount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_usage_discount_adjustment + end + + type plan_phase_amount_discount_adjustment = + { + id: String, + adjustment_type: :amount_discount, + amount_discount: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :amount_discount + + attr_accessor amount_discount: String + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + amount_discount: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :amount_discount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_amount_discount_adjustment + end + + type plan_phase_percentage_discount_adjustment = + { + id: String, + adjustment_type: :percentage_discount, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + percentage_discount: Float, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :percentage_discount + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor percentage_discount: Float + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + percentage_discount: Float, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :percentage_discount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_percentage_discount_adjustment + end + + type plan_phase_minimum_adjustment = + { + id: String, + adjustment_type: :minimum, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + item_id: String, + minimum_amount: String, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :minimum + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor item_id: String + + attr_accessor minimum_amount: String + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + item_id: String, + minimum_amount: String, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :minimum + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_minimum_adjustment + end + + type plan_phase_maximum_adjustment = + { + id: String, + adjustment_type: :maximum, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + maximum_amount: String, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :maximum + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor maximum_amount: String + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + maximum_amount: String, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :maximum + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_maximum_adjustment + end + + def self?.variants: -> [Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeApplyResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + end + end + + type billing_cycle_anchor_configuration = + { day: Integer, month: Integer?, year: Integer? } + + class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel + attr_accessor day: Integer + + attr_accessor month: Integer? + + attr_accessor year: Integer? + + def initialize: ( + day: Integer, + ?month: Integer?, + ?year: Integer? + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::billing_cycle_anchor_configuration + end + + type discount_interval = + Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval + | Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval + | Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval + + module DiscountInterval + extend Orb::Internal::Type::Union + + type amount_discount_interval = + { + amount_discount: String, + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + discount_type: :amount, + end_date: Time?, + start_date: Time + } + + class AmountDiscountInterval < Orb::Internal::Type::BaseModel + attr_accessor amount_discount: String + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor discount_type: :amount + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + def initialize: ( + amount_discount: String, + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time, + ?discount_type: :amount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::amount_discount_interval + end + + type percentage_discount_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + discount_type: :percentage, + end_date: Time?, + percentage_discount: Float, + start_date: Time + } + + class PercentageDiscountInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor discount_type: :percentage + + attr_accessor end_date: Time? + + attr_accessor percentage_discount: Float + + attr_accessor start_date: Time + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + percentage_discount: Float, + start_date: Time, + ?discount_type: :percentage + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::percentage_discount_interval + end + + type usage_discount_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + discount_type: :usage, + end_date: Time?, + start_date: Time, + usage_discount: Float + } + + class UsageDiscountInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor discount_type: :usage + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + attr_accessor usage_discount: Float + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time, + usage_discount: Float, + ?discount_type: :usage + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::usage_discount_interval + end + + def self?.variants: -> [Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeApplyResponse::Subscription::DiscountInterval::UsageDiscountInterval] + end + + type fixed_fee_quantity_schedule = + { + end_date: Time?, + price_id: String, + quantity: Float, + start_date: Time + } + + class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel + attr_accessor end_date: Time? + + attr_accessor price_id: String + + attr_accessor quantity: Float + + attr_accessor start_date: Time + + def initialize: ( + end_date: Time?, + price_id: String, + quantity: Float, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::fixed_fee_quantity_schedule + end + + type maximum_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + maximum_amount: String, + start_date: Time + } + + class MaximumInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor end_date: Time? + + attr_accessor maximum_amount: String + + attr_accessor start_date: Time + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + maximum_amount: String, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::maximum_interval + end + + type minimum_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + minimum_amount: String, + start_date: Time + } + + class MinimumInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor end_date: Time? + + attr_accessor minimum_amount: String + + attr_accessor start_date: Time + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + minimum_amount: String, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::minimum_interval + end + + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::pending_subscription_change + end + + type price_interval = + { + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + end_date: Time?, + filter: String?, + fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]?, + price: Orb::Models::price, + start_date: Time, + usage_customer_ids: ::Array[String]? + } + + class PriceInterval < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor billing_cycle_day: Integer + + attr_accessor current_billing_period_end_date: Time? + + attr_accessor current_billing_period_start_date: Time? + + attr_accessor end_date: Time? + + attr_accessor filter: String? + + attr_accessor fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]? + + attr_accessor price: Orb::Models::price + + attr_accessor start_date: Time + + attr_accessor usage_customer_ids: ::Array[String]? + + def initialize: ( + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + end_date: Time?, + filter: String?, + fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]?, + price: Orb::Models::price, + start_date: Time, + usage_customer_ids: ::Array[String]? + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::price_interval + + type fixed_fee_quantity_transition = + { effective_date: Time, price_id: String, quantity: Integer } + + class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel + attr_accessor effective_date: Time + + attr_accessor price_id: String + + attr_accessor quantity: Integer + + def initialize: ( + effective_date: Time, + price_id: String, + quantity: Integer + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::PriceInterval::fixed_fee_quantity_transition + end + end + + type redeemed_coupon = + { coupon_id: String, end_date: Time?, start_date: Time } + + class RedeemedCoupon < Orb::Internal::Type::BaseModel + attr_accessor coupon_id: String + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + def initialize: ( + coupon_id: String, + end_date: Time?, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::redeemed_coupon + end + + type status = :active | :ended | :upcoming + + module Status + extend Orb::Internal::Type::Enum + + ACTIVE: :active + ENDED: :ended + UPCOMING: :upcoming + + def self?.values: -> ::Array[Orb::Models::SubscriptionChangeApplyResponse::Subscription::status] + end + + type trial_info = { end_date: Time? } + + class TrialInfo < Orb::Internal::Type::BaseModel + attr_accessor end_date: Time? + + def initialize: (end_date: Time?) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::trial_info + end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeApplyResponse::Subscription::changed_resources + end + end + end + end +end diff --git a/sig/orb/models/subscription_change_cancel_params.rbs b/sig/orb/models/subscription_change_cancel_params.rbs new file mode 100644 index 00000000..7db5567f --- /dev/null +++ b/sig/orb/models/subscription_change_cancel_params.rbs @@ -0,0 +1,15 @@ +module Orb + module Models + type subscription_change_cancel_params = + { } & Orb::Internal::Type::request_parameters + + class SubscriptionChangeCancelParams < Orb::Internal::Type::BaseModel + extend Orb::Internal::Type::RequestParameters::Converter + include Orb::Internal::Type::RequestParameters + + def initialize: (?request_options: Orb::request_opts) -> void + + def to_hash: -> Orb::Models::subscription_change_cancel_params + end + end +end diff --git a/sig/orb/models/subscription_change_cancel_response.rbs b/sig/orb/models/subscription_change_cancel_response.rbs new file mode 100644 index 00000000..7d471058 --- /dev/null +++ b/sig/orb/models/subscription_change_cancel_response.rbs @@ -0,0 +1,784 @@ +module Orb + module Models + type subscription_change_cancel_response = + { + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeCancelResponse::status, + subscription: Orb::Models::SubscriptionChangeCancelResponse::Subscription?, + applied_at: Time?, + cancelled_at: Time? + } + + class SubscriptionChangeCancelResponse < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor expiration_time: Time + + attr_accessor status: Orb::Models::SubscriptionChangeCancelResponse::status + + attr_accessor subscription: Orb::Models::SubscriptionChangeCancelResponse::Subscription? + + attr_accessor applied_at: Time? + + attr_accessor cancelled_at: Time? + + def initialize: ( + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeCancelResponse::status, + subscription: Orb::Models::SubscriptionChangeCancelResponse::Subscription?, + ?applied_at: Time?, + ?cancelled_at: Time? + ) -> void + + def to_hash: -> Orb::Models::subscription_change_cancel_response + + type status = :pending | :applied | :cancelled + + module Status + extend Orb::Internal::Type::Enum + + PENDING: :pending + APPLIED: :applied + CANCELLED: :cancelled + + def self?.values: -> ::Array[Orb::Models::SubscriptionChangeCancelResponse::status] + end + + type subscription = + { + id: String, + active_plan_phase_order: Integer?, + adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval], + auto_collection: bool?, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + customer: Orb::Models::Customer, + default_invoice_memo: String?, + discount_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::discount_interval], + end_date: Time?, + fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::FixedFeeQuantitySchedule], + invoicing_threshold: String?, + maximum_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval], + metadata: ::Hash[Symbol, String], + minimum_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval], + net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange?, + plan: Orb::Models::Plan, + price_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval], + redeemed_coupon: Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon?, + start_date: Time, + status: Orb::Models::SubscriptionChangeCancelResponse::Subscription::status, + trial_info: Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo, + changed_resources: Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources? + } + + class Subscription < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor active_plan_phase_order: Integer? + + attr_accessor adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval] + + attr_accessor auto_collection: bool? + + attr_accessor billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration + + attr_accessor billing_cycle_day: Integer + + attr_accessor created_at: Time + + attr_accessor current_billing_period_end_date: Time? + + attr_accessor current_billing_period_start_date: Time? + + attr_accessor customer: Orb::Models::Customer + + attr_accessor default_invoice_memo: String? + + attr_accessor discount_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::discount_interval] + + attr_accessor end_date: Time? + + attr_accessor fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::FixedFeeQuantitySchedule] + + attr_accessor invoicing_threshold: String? + + attr_accessor maximum_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval] + + attr_accessor metadata: ::Hash[Symbol, String] + + attr_accessor minimum_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval] + + attr_accessor net_terms: Integer + + attr_accessor pending_subscription_change: Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange? + + attr_accessor plan: Orb::Models::Plan + + attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval] + + attr_accessor redeemed_coupon: Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon? + + attr_accessor start_date: Time + + attr_accessor status: Orb::Models::SubscriptionChangeCancelResponse::Subscription::status + + attr_accessor trial_info: Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo + + attr_accessor changed_resources: Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources? + + def initialize: ( + id: String, + active_plan_phase_order: Integer?, + adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval], + auto_collection: bool?, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + customer: Orb::Models::Customer, + default_invoice_memo: String?, + discount_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::discount_interval], + end_date: Time?, + fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::FixedFeeQuantitySchedule], + invoicing_threshold: String?, + maximum_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval], + metadata: ::Hash[Symbol, String], + minimum_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval], + net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange?, + plan: Orb::Models::Plan, + price_intervals: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval], + redeemed_coupon: Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon?, + start_date: Time, + status: Orb::Models::SubscriptionChangeCancelResponse::Subscription::status, + trial_info: Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionChangeCancelResponse::Subscription::ChangedResources? + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::subscription + + type adjustment_interval = + { + id: String, + adjustment: Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::adjustment, + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time + } + + class AdjustmentInterval < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment: Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::adjustment + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + def initialize: ( + id: String, + adjustment: Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::adjustment, + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::adjustment_interval + + type adjustment = + Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment + | Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment + | Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment + | Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment + | Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + + module Adjustment + extend Orb::Internal::Type::Union + + type plan_phase_usage_discount_adjustment = + { + id: String, + adjustment_type: :usage_discount, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String?, + usage_discount: Float + } + + class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :usage_discount + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + attr_accessor usage_discount: Float + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String?, + usage_discount: Float, + ?adjustment_type: :usage_discount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_usage_discount_adjustment + end + + type plan_phase_amount_discount_adjustment = + { + id: String, + adjustment_type: :amount_discount, + amount_discount: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :amount_discount + + attr_accessor amount_discount: String + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + amount_discount: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :amount_discount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_amount_discount_adjustment + end + + type plan_phase_percentage_discount_adjustment = + { + id: String, + adjustment_type: :percentage_discount, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + percentage_discount: Float, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :percentage_discount + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor percentage_discount: Float + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + percentage_discount: Float, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :percentage_discount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_percentage_discount_adjustment + end + + type plan_phase_minimum_adjustment = + { + id: String, + adjustment_type: :minimum, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + item_id: String, + minimum_amount: String, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :minimum + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor item_id: String + + attr_accessor minimum_amount: String + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + item_id: String, + minimum_amount: String, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :minimum + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_minimum_adjustment + end + + type plan_phase_maximum_adjustment = + { + id: String, + adjustment_type: :maximum, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + maximum_amount: String, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :maximum + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor maximum_amount: String + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + maximum_amount: String, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :maximum + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_maximum_adjustment + end + + def self?.variants: -> [Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + end + end + + type billing_cycle_anchor_configuration = + { day: Integer, month: Integer?, year: Integer? } + + class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel + attr_accessor day: Integer + + attr_accessor month: Integer? + + attr_accessor year: Integer? + + def initialize: ( + day: Integer, + ?month: Integer?, + ?year: Integer? + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::billing_cycle_anchor_configuration + end + + type discount_interval = + Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval + | Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval + | Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval + + module DiscountInterval + extend Orb::Internal::Type::Union + + type amount_discount_interval = + { + amount_discount: String, + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + discount_type: :amount, + end_date: Time?, + start_date: Time + } + + class AmountDiscountInterval < Orb::Internal::Type::BaseModel + attr_accessor amount_discount: String + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor discount_type: :amount + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + def initialize: ( + amount_discount: String, + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time, + ?discount_type: :amount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::amount_discount_interval + end + + type percentage_discount_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + discount_type: :percentage, + end_date: Time?, + percentage_discount: Float, + start_date: Time + } + + class PercentageDiscountInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor discount_type: :percentage + + attr_accessor end_date: Time? + + attr_accessor percentage_discount: Float + + attr_accessor start_date: Time + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + percentage_discount: Float, + start_date: Time, + ?discount_type: :percentage + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::percentage_discount_interval + end + + type usage_discount_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + discount_type: :usage, + end_date: Time?, + start_date: Time, + usage_discount: Float + } + + class UsageDiscountInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor discount_type: :usage + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + attr_accessor usage_discount: Float + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time, + usage_discount: Float, + ?discount_type: :usage + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::usage_discount_interval + end + + def self?.variants: -> [Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::UsageDiscountInterval] + end + + type fixed_fee_quantity_schedule = + { + end_date: Time?, + price_id: String, + quantity: Float, + start_date: Time + } + + class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel + attr_accessor end_date: Time? + + attr_accessor price_id: String + + attr_accessor quantity: Float + + attr_accessor start_date: Time + + def initialize: ( + end_date: Time?, + price_id: String, + quantity: Float, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::fixed_fee_quantity_schedule + end + + type maximum_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + maximum_amount: String, + start_date: Time + } + + class MaximumInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor end_date: Time? + + attr_accessor maximum_amount: String + + attr_accessor start_date: Time + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + maximum_amount: String, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::maximum_interval + end + + type minimum_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + minimum_amount: String, + start_date: Time + } + + class MinimumInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor end_date: Time? + + attr_accessor minimum_amount: String + + attr_accessor start_date: Time + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + minimum_amount: String, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::minimum_interval + end + + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::pending_subscription_change + end + + type price_interval = + { + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + end_date: Time?, + filter: String?, + fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]?, + price: Orb::Models::price, + start_date: Time, + usage_customer_ids: ::Array[String]? + } + + class PriceInterval < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor billing_cycle_day: Integer + + attr_accessor current_billing_period_end_date: Time? + + attr_accessor current_billing_period_start_date: Time? + + attr_accessor end_date: Time? + + attr_accessor filter: String? + + attr_accessor fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]? + + attr_accessor price: Orb::Models::price + + attr_accessor start_date: Time + + attr_accessor usage_customer_ids: ::Array[String]? + + def initialize: ( + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + end_date: Time?, + filter: String?, + fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]?, + price: Orb::Models::price, + start_date: Time, + usage_customer_ids: ::Array[String]? + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::price_interval + + type fixed_fee_quantity_transition = + { effective_date: Time, price_id: String, quantity: Integer } + + class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel + attr_accessor effective_date: Time + + attr_accessor price_id: String + + attr_accessor quantity: Integer + + def initialize: ( + effective_date: Time, + price_id: String, + quantity: Integer + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::fixed_fee_quantity_transition + end + end + + type redeemed_coupon = + { coupon_id: String, end_date: Time?, start_date: Time } + + class RedeemedCoupon < Orb::Internal::Type::BaseModel + attr_accessor coupon_id: String + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + def initialize: ( + coupon_id: String, + end_date: Time?, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::redeemed_coupon + end + + type status = :active | :ended | :upcoming + + module Status + extend Orb::Internal::Type::Enum + + ACTIVE: :active + ENDED: :ended + UPCOMING: :upcoming + + def self?.values: -> ::Array[Orb::Models::SubscriptionChangeCancelResponse::Subscription::status] + end + + type trial_info = { end_date: Time? } + + class TrialInfo < Orb::Internal::Type::BaseModel + attr_accessor end_date: Time? + + def initialize: (end_date: Time?) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::trial_info + end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeCancelResponse::Subscription::changed_resources + end + end + end + end +end diff --git a/sig/orb/models/subscription_change_retrieve_params.rbs b/sig/orb/models/subscription_change_retrieve_params.rbs new file mode 100644 index 00000000..18648e49 --- /dev/null +++ b/sig/orb/models/subscription_change_retrieve_params.rbs @@ -0,0 +1,15 @@ +module Orb + module Models + type subscription_change_retrieve_params = + { } & Orb::Internal::Type::request_parameters + + class SubscriptionChangeRetrieveParams < Orb::Internal::Type::BaseModel + extend Orb::Internal::Type::RequestParameters::Converter + include Orb::Internal::Type::RequestParameters + + def initialize: (?request_options: Orb::request_opts) -> void + + def to_hash: -> Orb::Models::subscription_change_retrieve_params + end + end +end diff --git a/sig/orb/models/subscription_change_retrieve_response.rbs b/sig/orb/models/subscription_change_retrieve_response.rbs new file mode 100644 index 00000000..a4e92578 --- /dev/null +++ b/sig/orb/models/subscription_change_retrieve_response.rbs @@ -0,0 +1,784 @@ +module Orb + module Models + type subscription_change_retrieve_response = + { + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeRetrieveResponse::status, + subscription: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription?, + applied_at: Time?, + cancelled_at: Time? + } + + class SubscriptionChangeRetrieveResponse < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor expiration_time: Time + + attr_accessor status: Orb::Models::SubscriptionChangeRetrieveResponse::status + + attr_accessor subscription: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription? + + attr_accessor applied_at: Time? + + attr_accessor cancelled_at: Time? + + def initialize: ( + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeRetrieveResponse::status, + subscription: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription?, + ?applied_at: Time?, + ?cancelled_at: Time? + ) -> void + + def to_hash: -> Orb::Models::subscription_change_retrieve_response + + type status = :pending | :applied | :cancelled + + module Status + extend Orb::Internal::Type::Enum + + PENDING: :pending + APPLIED: :applied + CANCELLED: :cancelled + + def self?.values: -> ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::status] + end + + type subscription = + { + id: String, + active_plan_phase_order: Integer?, + adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval], + auto_collection: bool?, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + customer: Orb::Models::Customer, + default_invoice_memo: String?, + discount_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::discount_interval], + end_date: Time?, + fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule], + invoicing_threshold: String?, + maximum_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval], + metadata: ::Hash[Symbol, String], + minimum_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval], + net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange?, + plan: Orb::Models::Plan, + price_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval], + redeemed_coupon: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon?, + start_date: Time, + status: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::status, + trial_info: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo, + changed_resources: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources? + } + + class Subscription < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor active_plan_phase_order: Integer? + + attr_accessor adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval] + + attr_accessor auto_collection: bool? + + attr_accessor billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration + + attr_accessor billing_cycle_day: Integer + + attr_accessor created_at: Time + + attr_accessor current_billing_period_end_date: Time? + + attr_accessor current_billing_period_start_date: Time? + + attr_accessor customer: Orb::Models::Customer + + attr_accessor default_invoice_memo: String? + + attr_accessor discount_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::discount_interval] + + attr_accessor end_date: Time? + + attr_accessor fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule] + + attr_accessor invoicing_threshold: String? + + attr_accessor maximum_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval] + + attr_accessor metadata: ::Hash[Symbol, String] + + attr_accessor minimum_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval] + + attr_accessor net_terms: Integer + + attr_accessor pending_subscription_change: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange? + + attr_accessor plan: Orb::Models::Plan + + attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval] + + attr_accessor redeemed_coupon: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon? + + attr_accessor start_date: Time + + attr_accessor status: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::status + + attr_accessor trial_info: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo + + attr_accessor changed_resources: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources? + + def initialize: ( + id: String, + active_plan_phase_order: Integer?, + adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval], + auto_collection: bool?, + billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration, + billing_cycle_day: Integer, + created_at: Time, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + customer: Orb::Models::Customer, + default_invoice_memo: String?, + discount_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::discount_interval], + end_date: Time?, + fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule], + invoicing_threshold: String?, + maximum_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval], + metadata: ::Hash[Symbol, String], + minimum_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval], + net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange?, + plan: Orb::Models::Plan, + price_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval], + redeemed_coupon: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon?, + start_date: Time, + status: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::status, + trial_info: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources? + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::subscription + + type adjustment_interval = + { + id: String, + adjustment: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::adjustment, + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time + } + + class AdjustmentInterval < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::adjustment + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + def initialize: ( + id: String, + adjustment: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::adjustment, + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::adjustment_interval + + type adjustment = + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment + | Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment + | Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment + | Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment + | Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment + + module Adjustment + extend Orb::Internal::Type::Union + + type plan_phase_usage_discount_adjustment = + { + id: String, + adjustment_type: :usage_discount, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String?, + usage_discount: Float + } + + class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :usage_discount + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + attr_accessor usage_discount: Float + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String?, + usage_discount: Float, + ?adjustment_type: :usage_discount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_usage_discount_adjustment + end + + type plan_phase_amount_discount_adjustment = + { + id: String, + adjustment_type: :amount_discount, + amount_discount: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :amount_discount + + attr_accessor amount_discount: String + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + amount_discount: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :amount_discount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_amount_discount_adjustment + end + + type plan_phase_percentage_discount_adjustment = + { + id: String, + adjustment_type: :percentage_discount, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + percentage_discount: Float, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :percentage_discount + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor percentage_discount: Float + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + percentage_discount: Float, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :percentage_discount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_percentage_discount_adjustment + end + + type plan_phase_minimum_adjustment = + { + id: String, + adjustment_type: :minimum, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + item_id: String, + minimum_amount: String, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :minimum + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor item_id: String + + attr_accessor minimum_amount: String + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + item_id: String, + minimum_amount: String, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :minimum + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_minimum_adjustment + end + + type plan_phase_maximum_adjustment = + { + id: String, + adjustment_type: :maximum, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + maximum_amount: String, + plan_phase_order: Integer?, + reason: String? + } + + class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor adjustment_type: :maximum + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor is_invoice_level: bool + + attr_accessor maximum_amount: String + + attr_accessor plan_phase_order: Integer? + + attr_accessor reason: String? + + def initialize: ( + id: String, + applies_to_price_ids: ::Array[String], + is_invoice_level: bool, + maximum_amount: String, + plan_phase_order: Integer?, + reason: String?, + ?adjustment_type: :maximum + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::plan_phase_maximum_adjustment + end + + def self?.variants: -> [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment] + end + end + + type billing_cycle_anchor_configuration = + { day: Integer, month: Integer?, year: Integer? } + + class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel + attr_accessor day: Integer + + attr_accessor month: Integer? + + attr_accessor year: Integer? + + def initialize: ( + day: Integer, + ?month: Integer?, + ?year: Integer? + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::billing_cycle_anchor_configuration + end + + type discount_interval = + Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval + | Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval + | Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval + + module DiscountInterval + extend Orb::Internal::Type::Union + + type amount_discount_interval = + { + amount_discount: String, + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + discount_type: :amount, + end_date: Time?, + start_date: Time + } + + class AmountDiscountInterval < Orb::Internal::Type::BaseModel + attr_accessor amount_discount: String + + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor discount_type: :amount + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + def initialize: ( + amount_discount: String, + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time, + ?discount_type: :amount + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::amount_discount_interval + end + + type percentage_discount_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + discount_type: :percentage, + end_date: Time?, + percentage_discount: Float, + start_date: Time + } + + class PercentageDiscountInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor discount_type: :percentage + + attr_accessor end_date: Time? + + attr_accessor percentage_discount: Float + + attr_accessor start_date: Time + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + percentage_discount: Float, + start_date: Time, + ?discount_type: :percentage + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::percentage_discount_interval + end + + type usage_discount_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + discount_type: :usage, + end_date: Time?, + start_date: Time, + usage_discount: Float + } + + class UsageDiscountInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor discount_type: :usage + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + attr_accessor usage_discount: Float + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + start_date: Time, + usage_discount: Float, + ?discount_type: :usage + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::usage_discount_interval + end + + def self?.variants: -> [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval] + end + + type fixed_fee_quantity_schedule = + { + end_date: Time?, + price_id: String, + quantity: Float, + start_date: Time + } + + class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel + attr_accessor end_date: Time? + + attr_accessor price_id: String + + attr_accessor quantity: Float + + attr_accessor start_date: Time + + def initialize: ( + end_date: Time?, + price_id: String, + quantity: Float, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::fixed_fee_quantity_schedule + end + + type maximum_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + maximum_amount: String, + start_date: Time + } + + class MaximumInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor end_date: Time? + + attr_accessor maximum_amount: String + + attr_accessor start_date: Time + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + maximum_amount: String, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::maximum_interval + end + + type minimum_interval = + { + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + minimum_amount: String, + start_date: Time + } + + class MinimumInterval < Orb::Internal::Type::BaseModel + attr_accessor applies_to_price_ids: ::Array[String] + + attr_accessor applies_to_price_interval_ids: ::Array[String] + + attr_accessor end_date: Time? + + attr_accessor minimum_amount: String + + attr_accessor start_date: Time + + def initialize: ( + applies_to_price_ids: ::Array[String], + applies_to_price_interval_ids: ::Array[String], + end_date: Time?, + minimum_amount: String, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::minimum_interval + end + + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::pending_subscription_change + end + + type price_interval = + { + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + end_date: Time?, + filter: String?, + fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]?, + price: Orb::Models::price, + start_date: Time, + usage_customer_ids: ::Array[String]? + } + + class PriceInterval < Orb::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor billing_cycle_day: Integer + + attr_accessor current_billing_period_end_date: Time? + + attr_accessor current_billing_period_start_date: Time? + + attr_accessor end_date: Time? + + attr_accessor filter: String? + + attr_accessor fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]? + + attr_accessor price: Orb::Models::price + + attr_accessor start_date: Time + + attr_accessor usage_customer_ids: ::Array[String]? + + def initialize: ( + id: String, + billing_cycle_day: Integer, + current_billing_period_end_date: Time?, + current_billing_period_start_date: Time?, + end_date: Time?, + filter: String?, + fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]?, + price: Orb::Models::price, + start_date: Time, + usage_customer_ids: ::Array[String]? + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::price_interval + + type fixed_fee_quantity_transition = + { effective_date: Time, price_id: String, quantity: Integer } + + class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel + attr_accessor effective_date: Time + + attr_accessor price_id: String + + attr_accessor quantity: Integer + + def initialize: ( + effective_date: Time, + price_id: String, + quantity: Integer + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::fixed_fee_quantity_transition + end + end + + type redeemed_coupon = + { coupon_id: String, end_date: Time?, start_date: Time } + + class RedeemedCoupon < Orb::Internal::Type::BaseModel + attr_accessor coupon_id: String + + attr_accessor end_date: Time? + + attr_accessor start_date: Time + + def initialize: ( + coupon_id: String, + end_date: Time?, + start_date: Time + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::redeemed_coupon + end + + type status = :active | :ended | :upcoming + + module Status + extend Orb::Internal::Type::Enum + + ACTIVE: :active + ENDED: :ended + UPCOMING: :upcoming + + def self?.values: -> ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::status] + end + + type trial_info = { end_date: Time? } + + class TrialInfo < Orb::Internal::Type::BaseModel + attr_accessor end_date: Time? + + def initialize: (end_date: Time?) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::trial_info + end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::changed_resources + end + end + end + end +end diff --git a/sig/orb/models/subscription_create_response.rbs b/sig/orb/models/subscription_create_response.rbs index 0e317e9a..264231f2 100644 --- a/sig/orb/models/subscription_create_response.rbs +++ b/sig/orb/models/subscription_create_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionCreateResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionCreateResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionCreateResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionCreateResponse::status, - trial_info: Orb::Models::SubscriptionCreateResponse::TrialInfo + trial_info: Orb::Models::SubscriptionCreateResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionCreateResponse::ChangedResources? } class SubscriptionCreateResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionCreateResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionCreateResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionCreateResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionCreateResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionCreateResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionCreateResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionCreateResponse::status, - trial_info: Orb::Models::SubscriptionCreateResponse::TrialInfo + trial_info: Orb::Models::SubscriptionCreateResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionCreateResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_create_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionCreateResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionCreateResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionCreateResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionCreateResponse::changed_resources + end end end end diff --git a/sig/orb/models/subscription_price_intervals_response.rbs b/sig/orb/models/subscription_price_intervals_response.rbs index adbb738f..caf72919 100644 --- a/sig/orb/models/subscription_price_intervals_response.rbs +++ b/sig/orb/models/subscription_price_intervals_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionPriceIntervalsResponse::status, - trial_info: Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo + trial_info: Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources? } class SubscriptionPriceIntervalsResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionPriceIntervalsResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionPriceIntervalsResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionPriceIntervalsResponse::status, - trial_info: Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo + trial_info: Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_price_intervals_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionPriceIntervalsResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionPriceIntervalsResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionPriceIntervalsResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionPriceIntervalsResponse::changed_resources + end end end end diff --git a/sig/orb/models/subscription_schedule_plan_change_response.rbs b/sig/orb/models/subscription_schedule_plan_change_response.rbs index a9bc080d..03c23694 100644 --- a/sig/orb/models/subscription_schedule_plan_change_response.rbs +++ b/sig/orb/models/subscription_schedule_plan_change_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionSchedulePlanChangeResponse::status, - trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo + trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources? } class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionSchedulePlanChangeResponse::status, - trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo + trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_schedule_plan_change_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionSchedulePlanChangeResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionSchedulePlanChangeResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionSchedulePlanChangeResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionSchedulePlanChangeResponse::changed_resources + end end end end diff --git a/sig/orb/models/subscription_trigger_phase_response.rbs b/sig/orb/models/subscription_trigger_phase_response.rbs index 1a01886c..da8a5aeb 100644 --- a/sig/orb/models/subscription_trigger_phase_response.rbs +++ b/sig/orb/models/subscription_trigger_phase_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionTriggerPhaseResponse::status, - trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo + trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources? } class SubscriptionTriggerPhaseResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionTriggerPhaseResponse::status, - trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo + trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_trigger_phase_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionTriggerPhaseResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionTriggerPhaseResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionTriggerPhaseResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionTriggerPhaseResponse::changed_resources + end end end end diff --git a/sig/orb/models/subscription_unschedule_cancellation_response.rbs b/sig/orb/models/subscription_unschedule_cancellation_response.rbs index 5d90fb46..b6ee06ac 100644 --- a/sig/orb/models/subscription_unschedule_cancellation_response.rbs +++ b/sig/orb/models/subscription_unschedule_cancellation_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUnscheduleCancellationResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUnscheduleCancellationResponse::status, - trial_info: Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources? } class SubscriptionUnscheduleCancellationResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUnscheduleCancellationResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUnscheduleCancellationResponse::status, - trial_info: Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_unschedule_cancellation_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUnscheduleCancellationResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionUnscheduleCancellationResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUnscheduleCancellationResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionUnscheduleCancellationResponse::changed_resources + end end end end diff --git a/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs b/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs index 33c3462f..7dad1490 100644 --- a/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +++ b/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::status, - trial_info: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources? } class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::status, - trial_info: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_unschedule_fixed_fee_quantity_updates_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::changed_resources + end end end end diff --git a/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs b/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs index 01a3c742..fb96ea00 100644 --- a/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +++ b/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::status, - trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources? } class SubscriptionUnschedulePendingPlanChangesResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::status, - trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_unschedule_pending_plan_changes_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::changed_resources + end end end end diff --git a/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs b/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs index 64a328c0..0372f0fa 100644 --- a/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +++ b/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::status, - trial_info: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources? } class SubscriptionUpdateFixedFeeQuantityResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::status, - trial_info: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_update_fixed_fee_quantity_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::changed_resources + end end end end diff --git a/sig/orb/models/subscription_update_trial_response.rbs b/sig/orb/models/subscription_update_trial_response.rbs index 0cd44dc5..4826ab17 100644 --- a/sig/orb/models/subscription_update_trial_response.rbs +++ b/sig/orb/models/subscription_update_trial_response.rbs @@ -21,12 +21,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUpdateTrialResponse::status, - trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources? } class SubscriptionUpdateTrialResponse < Orb::Internal::Type::BaseModel @@ -68,6 +70,8 @@ module Orb attr_accessor net_terms: Integer + attr_accessor pending_subscription_change: Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange? + attr_accessor plan: Orb::Models::Plan attr_accessor price_intervals: ::Array[Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval] @@ -80,6 +84,8 @@ module Orb attr_accessor trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo + attr_accessor changed_resources: Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources? + def initialize: ( id: String, active_plan_phase_order: Integer?, @@ -100,12 +106,14 @@ module Orb metadata: ::Hash[Symbol, String], minimum_intervals: ::Array[Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval], net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange?, plan: Orb::Models::Plan, price_intervals: ::Array[Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval], redeemed_coupon: Orb::Models::SubscriptionUpdateTrialResponse::RedeemedCoupon?, start_date: Time, status: Orb::Models::SubscriptionUpdateTrialResponse::status, - trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo + trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo, + ?changed_resources: Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources? ) -> void def to_hash: -> Orb::Models::subscription_update_trial_response @@ -572,6 +580,16 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUpdateTrialResponse::minimum_interval end + type pending_subscription_change = { id: String } + + class PendingSubscriptionChange < Orb::Internal::Type::BaseModel + attr_accessor id: String + + def initialize: (id: String) -> void + + def to_hash: -> Orb::Models::SubscriptionUpdateTrialResponse::pending_subscription_change + end + type price_interval = { id: String, @@ -682,6 +700,33 @@ module Orb def to_hash: -> Orb::Models::SubscriptionUpdateTrialResponse::trial_info end + + type changed_resources = + { + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + } + + class ChangedResources < Orb::Internal::Type::BaseModel + attr_accessor created_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor created_invoices: ::Array[Orb::Models::Invoice] + + attr_accessor voided_credit_notes: ::Array[Orb::Models::CreditNote] + + attr_accessor voided_invoices: ::Array[Orb::Models::Invoice] + + def initialize: ( + created_credit_notes: ::Array[Orb::Models::CreditNote], + created_invoices: ::Array[Orb::Models::Invoice], + voided_credit_notes: ::Array[Orb::Models::CreditNote], + voided_invoices: ::Array[Orb::Models::Invoice] + ) -> void + + def to_hash: -> Orb::Models::SubscriptionUpdateTrialResponse::changed_resources + end end end end diff --git a/sig/orb/resources/subscription_changes.rbs b/sig/orb/resources/subscription_changes.rbs new file mode 100644 index 00000000..7c13d48a --- /dev/null +++ b/sig/orb/resources/subscription_changes.rbs @@ -0,0 +1,24 @@ +module Orb + module Resources + class SubscriptionChanges + def retrieve: ( + String subscription_change_id, + ?request_options: Orb::request_opts + ) -> Orb::Models::SubscriptionChangeRetrieveResponse + + def apply: ( + String subscription_change_id, + ?description: String?, + ?previously_collected_amount: String?, + ?request_options: Orb::request_opts + ) -> Orb::Models::SubscriptionChangeApplyResponse + + def cancel: ( + String subscription_change_id, + ?request_options: Orb::request_opts + ) -> Orb::Models::SubscriptionChangeCancelResponse + + def initialize: (client: Orb::Client) -> void + end + end +end diff --git a/test/orb/resources/coupons/subscriptions_test.rb b/test/orb/resources/coupons/subscriptions_test.rb index 657bf49a..52d4c49b 100644 --- a/test/orb/resources/coupons/subscriptions_test.rb +++ b/test/orb/resources/coupons/subscriptions_test.rb @@ -38,6 +38,7 @@ def test_list metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::Subscription::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::PriceInterval]), redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon | nil, diff --git a/test/orb/resources/subscription_changes_test.rb b/test/orb/resources/subscription_changes_test.rb new file mode 100644 index 00000000..f96e6ae5 --- /dev/null +++ b/test/orb/resources/subscription_changes_test.rb @@ -0,0 +1,62 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Orb::Test::Resources::SubscriptionChangesTest < Orb::Test::ResourceTest + def test_retrieve + response = @orb.subscription_changes.retrieve("subscription_change_id") + + assert_pattern do + response => Orb::Models::SubscriptionChangeRetrieveResponse + end + + assert_pattern do + response => { + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeRetrieveResponse::Status, + subscription: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription | nil, + applied_at: Time | nil, + cancelled_at: Time | nil + } + end + end + + def test_apply + response = @orb.subscription_changes.apply("subscription_change_id") + + assert_pattern do + response => Orb::Models::SubscriptionChangeApplyResponse + end + + assert_pattern do + response => { + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeApplyResponse::Status, + subscription: Orb::Models::SubscriptionChangeApplyResponse::Subscription | nil, + applied_at: Time | nil, + cancelled_at: Time | nil + } + end + end + + def test_cancel + response = @orb.subscription_changes.cancel("subscription_change_id") + + assert_pattern do + response => Orb::Models::SubscriptionChangeCancelResponse + end + + assert_pattern do + response => { + id: String, + expiration_time: Time, + status: Orb::Models::SubscriptionChangeCancelResponse::Status, + subscription: Orb::Models::SubscriptionChangeCancelResponse::Subscription | nil, + applied_at: Time | nil, + cancelled_at: Time | nil + } + end + end +end diff --git a/test/orb/resources/subscriptions_test.rb b/test/orb/resources/subscriptions_test.rb index 6f8a3717..2dea7bdb 100644 --- a/test/orb/resources/subscriptions_test.rb +++ b/test/orb/resources/subscriptions_test.rb @@ -31,12 +31,14 @@ def test_create metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionCreateResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionCreateResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionCreateResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionCreateResponse::ChangedResources | nil } end end @@ -69,6 +71,7 @@ def test_update metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::Subscription::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::PriceInterval]), redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon | nil, @@ -114,6 +117,7 @@ def test_list metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::Subscription::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::PriceInterval]), redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon | nil, @@ -152,12 +156,14 @@ def test_cancel_required_params metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionCancelResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionCancelResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionCancelResponse::ChangedResources | nil } end end @@ -190,6 +196,7 @@ def test_fetch metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::Subscription::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::PriceInterval]), redeemed_coupon: Orb::Models::Subscription::RedeemedCoupon | nil, @@ -285,12 +292,14 @@ def test_price_intervals metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionPriceIntervalsResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionPriceIntervalsResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionPriceIntervalsResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionPriceIntervalsResponse::ChangedResources | nil } end end @@ -323,12 +332,14 @@ def test_schedule_plan_change_required_params metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources | nil } end end @@ -361,12 +372,14 @@ def test_trigger_phase metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources | nil } end end @@ -399,12 +412,14 @@ def test_unschedule_cancellation metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUnscheduleCancellationResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUnscheduleCancellationResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionUnscheduleCancellationResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUnscheduleCancellationResponse::ChangedResources | nil } end end @@ -438,12 +453,14 @@ def test_unschedule_fixed_fee_quantity_updates_required_params metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources | nil } end end @@ -476,12 +493,14 @@ def test_unschedule_pending_plan_changes metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::ChangedResources | nil } end end @@ -515,12 +534,14 @@ def test_update_fixed_fee_quantity_required_params metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::ChangedResources | nil } end end @@ -553,12 +574,14 @@ def test_update_trial_required_params metadata: ^(Orb::Internal::Type::HashOf[String]), minimum_intervals: ^(Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionUpdateTrialResponse::MinimumInterval]), net_terms: Integer, + pending_subscription_change: Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange | nil, plan: Orb::Models::Plan, price_intervals: ^(Orb::Internal::Type::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 + trial_info: Orb::Models::SubscriptionUpdateTrialResponse::TrialInfo, + changed_resources: Orb::Models::SubscriptionUpdateTrialResponse::ChangedResources | nil } end end From 637bcdb53257adf568d22c05b54f70570680a24b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 7 Apr 2025 22:09:45 +0000 Subject: [PATCH 8/8] release: 0.1.0-alpha.39 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 18 ++++++++++++++++++ lib/orb/version.rb | 2 +- 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 0c41cec4..0f02ea1c 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.38" + ".": "0.1.0-alpha.39" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index e259c735..937bb808 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,23 @@ # Changelog +## 0.1.0-alpha.39 (2025-04-07) + +Full Changelog: [v0.1.0-alpha.38...v0.1.0-alpha.39](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.38...v0.1.0-alpha.39) + +### Features + +* **api:** api update ([#237](https://github.com/orbcorp/orb-ruby/issues/237)) ([0bb6400](https://github.com/orbcorp/orb-ruby/commit/0bb6400deb4cb2ab6959e45ca9a53bc51e040d7a)) + + +### Chores + +* always fold up method bodies in sorbet type definitions ([#233](https://github.com/orbcorp/orb-ruby/issues/233)) ([af4a884](https://github.com/orbcorp/orb-ruby/commit/af4a884f3c7eab12b9688cfd3c6d412cbae5bd58)) +* **internal:** codegen related update ([#236](https://github.com/orbcorp/orb-ruby/issues/236)) ([8cf1bc4](https://github.com/orbcorp/orb-ruby/commit/8cf1bc47517a9262cbd58bf8c915b6a94b77cc96)) +* **internal:** more concise handling of parameter naming conflicts ([#235](https://github.com/orbcorp/orb-ruby/issues/235)) ([ad10a69](https://github.com/orbcorp/orb-ruby/commit/ad10a69558d15218af07ce8c34d234d2ff0946bc)) +* **internal:** rubocop rules ([#232](https://github.com/orbcorp/orb-ruby/issues/232)) ([6220144](https://github.com/orbcorp/orb-ruby/commit/62201445cab0f60cb1be36da6196da0fe7787d9b)) +* **internal:** version bump ([#230](https://github.com/orbcorp/orb-ruby/issues/230)) ([d5e0113](https://github.com/orbcorp/orb-ruby/commit/d5e01130d014493b793d03f8e19033aa906ab07b)) +* update yard comment formatting ([#234](https://github.com/orbcorp/orb-ruby/issues/234)) ([6211751](https://github.com/orbcorp/orb-ruby/commit/6211751f1f0c0aac4440d5d4faf76752a5e50acd)) + ## 0.1.0-alpha.38 (2025-04-05) Full Changelog: [v0.1.0-alpha.37...v0.1.0-alpha.38](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.37...v0.1.0-alpha.38) diff --git a/lib/orb/version.rb b/lib/orb/version.rb index 9f59eca5..d473e523 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.pre.alpha.38" + VERSION = "0.1.0.pre.alpha.39" end