From 42ffeebb1ea9141981bd5a92ad8268db02162d7b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 1 Apr 2025 09:08:36 +0000 Subject: [PATCH 1/8] chore(internal): version bump (#194) --- README.md | 2 +- sig/orb/version.rbs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d180c7f1..9600770a 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ The underlying REST API documentation can be found on [docs.withorb.com](https:/ To use this gem, install via Bundler by adding the following to your application's `Gemfile`: ```ruby -gem "orb", "~> 0.1.0.pre.alpha.30" +gem "orb", "~> 0.1.0.pre.alpha.31" ``` To fetch an initial copy of the gem: diff --git a/sig/orb/version.rbs b/sig/orb/version.rbs index 18def0f7..204a657b 100644 --- a/sig/orb/version.rbs +++ b/sig/orb/version.rbs @@ -1,3 +1,3 @@ module Orb - VERSION: "0.1.0-alpha.30" + VERSION: "0.1.0-alpha.31" end From d2e04d695150fc6253f47f00693f9967a7fa69d4 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 1 Apr 2025 15:58:57 +0000 Subject: [PATCH 2/8] chore(internal): codegen related update (#196) --- lib/orb/models/alert.rb | 6 + .../alert_create_for_customer_params.rb | 1 + ...ert_create_for_external_customer_params.rb | 1 + .../alert_create_for_subscription_params.rb | 1 + lib/orb/models/alert_disable_params.rb | 1 + lib/orb/models/alert_enable_params.rb | 1 + lib/orb/models/alert_list_params.rb | 1 + lib/orb/models/alert_retrieve_params.rb | 1 + lib/orb/models/alert_update_params.rb | 1 + lib/orb/models/amount_discount.rb | 1 + lib/orb/models/billable_metric.rb | 1 + lib/orb/models/coupon.rb | 1 + lib/orb/models/coupon_archive_params.rb | 1 + lib/orb/models/coupon_create_params.rb | 1 + lib/orb/models/coupon_fetch_params.rb | 1 + lib/orb/models/coupon_list_params.rb | 1 + .../coupons/subscription_list_params.rb | 1 + lib/orb/models/credit_note.rb | 7 + lib/orb/models/credit_note_create_params.rb | 1 + lib/orb/models/credit_note_fetch_params.rb | 1 + lib/orb/models/credit_note_list_params.rb | 1 + lib/orb/models/customer.rb | 12 + lib/orb/models/customer_create_params.rb | 3 + lib/orb/models/customer_delete_params.rb | 1 + .../customer_fetch_by_external_id_params.rb | 1 + lib/orb/models/customer_fetch_params.rb | 1 + lib/orb/models/customer_list_params.rb | 1 + ..._gateway_by_external_customer_id_params.rb | 1 + ...ync_payment_methods_from_gateway_params.rb | 1 + .../customer_update_by_external_id_params.rb | 3 + lib/orb/models/customer_update_params.rb | 3 + .../balance_transaction_create_params.rb | 1 + .../balance_transaction_create_response.rb | 4 + .../balance_transaction_list_params.rb | 1 + .../balance_transaction_list_response.rb | 4 + .../cost_list_by_external_id_params.rb | 1 + lib/orb/models/customers/cost_list_params.rb | 1 + .../credit_list_by_external_id_params.rb | 1 + .../credit_list_by_external_id_response.rb | 1 + .../models/customers/credit_list_params.rb | 1 + .../models/customers/credit_list_response.rb | 1 + ...dger_create_entry_by_external_id_params.rb | 1 + ...er_create_entry_by_external_id_response.rb | 21 + .../credits/ledger_create_entry_params.rb | 1 + .../credits/ledger_create_entry_response.rb | 21 + .../ledger_list_by_external_id_params.rb | 1 + .../ledger_list_by_external_id_response.rb | 21 + .../customers/credits/ledger_list_params.rb | 1 + .../customers/credits/ledger_list_response.rb | 21 + .../top_up_create_by_external_id_params.rb | 1 + .../top_up_create_by_external_id_response.rb | 3 + .../customers/credits/top_up_create_params.rb | 1 + .../credits/top_up_create_response.rb | 3 + .../top_up_delete_by_external_id_params.rb | 1 + .../customers/credits/top_up_delete_params.rb | 1 + .../top_up_list_by_external_id_params.rb | 1 + .../top_up_list_by_external_id_response.rb | 3 + .../customers/credits/top_up_list_params.rb | 1 + .../customers/credits/top_up_list_response.rb | 3 + .../dimensional_price_group_create_params.rb | 1 + .../dimensional_price_group_list_params.rb | 1 + ...dimensional_price_group_retrieve_params.rb | 1 + ...ensional_price_group_id_retrieve_params.rb | 1 + lib/orb/models/event_deprecate_params.rb | 1 + lib/orb/models/event_ingest_params.rb | 1 + lib/orb/models/event_ingest_response.rb | 1 + lib/orb/models/event_search_params.rb | 1 + lib/orb/models/event_update_params.rb | 1 + .../models/events/backfill_close_params.rb | 1 + .../models/events/backfill_close_response.rb | 2 + .../models/events/backfill_create_params.rb | 1 + .../models/events/backfill_create_response.rb | 2 + .../models/events/backfill_fetch_params.rb | 1 + .../models/events/backfill_fetch_response.rb | 2 + lib/orb/models/events/backfill_list_params.rb | 1 + .../models/events/backfill_list_response.rb | 2 + .../models/events/backfill_revert_params.rb | 1 + .../models/events/backfill_revert_response.rb | 2 + lib/orb/models/events/volume_list_params.rb | 1 + lib/orb/models/invoice.rb | 27 ++ lib/orb/models/invoice_create_params.rb | 3 + lib/orb/models/invoice_fetch_params.rb | 1 + .../models/invoice_fetch_upcoming_params.rb | 1 + .../models/invoice_fetch_upcoming_response.rb | 27 ++ lib/orb/models/invoice_issue_params.rb | 1 + .../models/invoice_line_item_create_params.rb | 1 + .../invoice_line_item_create_response.rb | 9 + lib/orb/models/invoice_list_params.rb | 1 + lib/orb/models/invoice_mark_paid_params.rb | 1 + lib/orb/models/invoice_pay_params.rb | 1 + lib/orb/models/invoice_update_params.rb | 1 + lib/orb/models/invoice_void_params.rb | 1 + lib/orb/models/item.rb | 1 + lib/orb/models/item_create_params.rb | 1 + lib/orb/models/item_fetch_params.rb | 1 + lib/orb/models/item_list_params.rb | 1 + lib/orb/models/item_update_params.rb | 2 + lib/orb/models/metric_create_params.rb | 1 + lib/orb/models/metric_fetch_params.rb | 1 + lib/orb/models/metric_list_params.rb | 1 + lib/orb/models/metric_update_params.rb | 1 + lib/orb/models/percentage_discount.rb | 1 + lib/orb/models/plan.rb | 10 + lib/orb/models/plan_create_params.rb | 209 +++++++++ lib/orb/models/plan_fetch_params.rb | 1 + lib/orb/models/plan_list_params.rb | 1 + lib/orb/models/plan_update_params.rb | 1 + .../plans/external_plan_id_fetch_params.rb | 1 + .../plans/external_plan_id_update_params.rb | 1 + lib/orb/models/price.rb | 345 ++++++++++++++ lib/orb/models/price_create_params.rb | 5 + lib/orb/models/price_evaluate_params.rb | 1 + lib/orb/models/price_fetch_params.rb | 1 + lib/orb/models/price_list_params.rb | 1 + lib/orb/models/price_update_params.rb | 1 + .../prices/external_price_id_fetch_params.rb | 1 + .../prices/external_price_id_update_params.rb | 1 + lib/orb/models/subscription.rb | 5 + lib/orb/models/subscription_cancel_params.rb | 1 + .../models/subscription_cancel_response.rb | 5 + lib/orb/models/subscription_create_params.rb | 433 ++++++++++++++++++ .../models/subscription_create_response.rb | 5 + .../models/subscription_fetch_costs_params.rb | 1 + lib/orb/models/subscription_fetch_params.rb | 1 + .../subscription_fetch_schedule_params.rb | 1 + .../subscription_fetch_schedule_response.rb | 1 + .../models/subscription_fetch_usage_params.rb | 1 + lib/orb/models/subscription_list_params.rb | 1 + .../subscription_price_intervals_params.rb | 257 +++++++++++ .../subscription_price_intervals_response.rb | 5 + ...ubscription_schedule_plan_change_params.rb | 433 ++++++++++++++++++ ...scription_schedule_plan_change_response.rb | 5 + .../subscription_trigger_phase_params.rb | 1 + .../subscription_trigger_phase_response.rb | 5 + ...cription_unschedule_cancellation_params.rb | 1 + ...iption_unschedule_cancellation_response.rb | 5 + ...edule_fixed_fee_quantity_updates_params.rb | 1 + ...ule_fixed_fee_quantity_updates_response.rb | 5 + ..._unschedule_pending_plan_changes_params.rb | 1 + ...nschedule_pending_plan_changes_response.rb | 5 + ...iption_update_fixed_fee_quantity_params.rb | 1 + ...tion_update_fixed_fee_quantity_response.rb | 5 + lib/orb/models/subscription_update_params.rb | 1 + .../subscription_update_trial_params.rb | 1 + .../subscription_update_trial_response.rb | 5 + lib/orb/models/subscription_usage.rb | 5 + lib/orb/models/top_level_ping_params.rb | 1 + lib/orb/models/trial_discount.rb | 1 + lib/orb/models/usage_discount.rb | 1 + lib/orb/resources/alerts.rb | 18 + lib/orb/resources/coupons.rb | 10 + lib/orb/resources/coupons/subscriptions.rb | 4 + lib/orb/resources/credit_notes.rb | 8 + lib/orb/resources/customers.rb | 20 + .../customers/balance_transactions.rb | 6 + lib/orb/resources/customers/costs.rb | 6 + lib/orb/resources/customers/credits.rb | 6 + lib/orb/resources/customers/credits/ledger.rb | 10 + .../resources/customers/credits/top_ups.rb | 14 + lib/orb/resources/dimensional_price_groups.rb | 8 + .../external_dimensional_price_group_id.rb | 4 + lib/orb/resources/events.rb | 10 + lib/orb/resources/events/backfills.rb | 12 + lib/orb/resources/events/volume.rb | 4 + lib/orb/resources/invoice_line_items.rb | 4 + lib/orb/resources/invoices.rb | 20 + lib/orb/resources/items.rb | 10 + lib/orb/resources/metrics.rb | 10 + lib/orb/resources/plans.rb | 10 + lib/orb/resources/plans/external_plan_id.rb | 6 + lib/orb/resources/prices.rb | 12 + lib/orb/resources/prices/external_price_id.rb | 6 + lib/orb/resources/subscriptions.rb | 34 ++ lib/orb/resources/top_level.rb | 4 + rbi/lib/orb/resources/alerts.rbi | 1 + rbi/lib/orb/resources/coupons.rbi | 1 + .../orb/resources/coupons/subscriptions.rbi | 1 + rbi/lib/orb/resources/credit_notes.rbi | 1 + rbi/lib/orb/resources/customers.rbi | 1 + .../customers/balance_transactions.rbi | 1 + rbi/lib/orb/resources/customers/costs.rbi | 1 + rbi/lib/orb/resources/customers/credits.rbi | 1 + .../resources/customers/credits/ledger.rbi | 1 + .../resources/customers/credits/top_ups.rbi | 1 + .../resources/dimensional_price_groups.rbi | 1 + .../external_dimensional_price_group_id.rbi | 1 + rbi/lib/orb/resources/events.rbi | 1 + rbi/lib/orb/resources/events/backfills.rbi | 1 + rbi/lib/orb/resources/events/volume.rbi | 1 + rbi/lib/orb/resources/invoice_line_items.rbi | 1 + rbi/lib/orb/resources/invoices.rbi | 1 + rbi/lib/orb/resources/items.rbi | 1 + rbi/lib/orb/resources/metrics.rbi | 1 + rbi/lib/orb/resources/plans.rbi | 1 + .../orb/resources/plans/external_plan_id.rbi | 1 + rbi/lib/orb/resources/prices.rbi | 1 + .../resources/prices/external_price_id.rbi | 1 + rbi/lib/orb/resources/subscriptions.rbi | 1 + rbi/lib/orb/resources/top_level.rbi | 1 + 199 files changed, 2353 insertions(+) diff --git a/lib/orb/models/alert.rb b/lib/orb/models/alert.rb index 416ae45f..4568689c 100644 --- a/lib/orb/models/alert.rb +++ b/lib/orb/models/alert.rb @@ -86,6 +86,7 @@ class Alert < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Alert#customer class Customer < Orb::BaseModel # @!attribute id # @@ -108,6 +109,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Alert#metric class Metric < Orb::BaseModel # @!attribute id # @@ -124,6 +126,7 @@ class Metric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Alert#plan class Plan < Orb::BaseModel # @!attribute id # @@ -161,6 +164,7 @@ class Plan < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Alert#subscription class Subscription < Orb::BaseModel # @!attribute id # @@ -198,6 +202,8 @@ class Threshold < Orb::BaseModel end # The type of alert. This must be a valid alert type. + # + # @see Orb::Models::Alert#type module Type extend Orb::Enum diff --git a/lib/orb/models/alert_create_for_customer_params.rb b/lib/orb/models/alert_create_for_customer_params.rb index fb7cc17b..c6fcec1c 100644 --- a/lib/orb/models/alert_create_for_customer_params.rb +++ b/lib/orb/models/alert_create_for_customer_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Alerts#create_for_customer class AlertCreateForCustomerParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 8ad244d0..0408e3aa 100644 --- a/lib/orb/models/alert_create_for_external_customer_params.rb +++ b/lib/orb/models/alert_create_for_external_customer_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Alerts#create_for_external_customer class AlertCreateForExternalCustomerParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/alert_create_for_subscription_params.rb b/lib/orb/models/alert_create_for_subscription_params.rb index 761322db..0b9f0c5b 100644 --- a/lib/orb/models/alert_create_for_subscription_params.rb +++ b/lib/orb/models/alert_create_for_subscription_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Alerts#create_for_subscription class AlertCreateForSubscriptionParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/alert_disable_params.rb b/lib/orb/models/alert_disable_params.rb index a13fe14a..6cc7ecc2 100644 --- a/lib/orb/models/alert_disable_params.rb +++ b/lib/orb/models/alert_disable_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Alerts#disable class AlertDisableParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/alert_enable_params.rb b/lib/orb/models/alert_enable_params.rb index 53d1a4fa..356574f9 100644 --- a/lib/orb/models/alert_enable_params.rb +++ b/lib/orb/models/alert_enable_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Alerts#enable class AlertEnableParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/alert_list_params.rb b/lib/orb/models/alert_list_params.rb index 98b2f92a..d0b758a1 100644 --- a/lib/orb/models/alert_list_params.rb +++ b/lib/orb/models/alert_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Alerts#list class AlertListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/alert_retrieve_params.rb b/lib/orb/models/alert_retrieve_params.rb index d44eeda1..e940171a 100644 --- a/lib/orb/models/alert_retrieve_params.rb +++ b/lib/orb/models/alert_retrieve_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Alerts#retrieve class AlertRetrieveParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/alert_update_params.rb b/lib/orb/models/alert_update_params.rb index 07626fa0..8a6126ba 100644 --- a/lib/orb/models/alert_update_params.rb +++ b/lib/orb/models/alert_update_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Alerts#update class AlertUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/amount_discount.rb b/lib/orb/models/amount_discount.rb index b6cdd9e0..0ecee7df 100644 --- a/lib/orb/models/amount_discount.rb +++ b/lib/orb/models/amount_discount.rb @@ -36,6 +36,7 @@ class AmountDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::AmountDiscount#discount_type module DiscountType extend Orb::Enum diff --git a/lib/orb/models/billable_metric.rb b/lib/orb/models/billable_metric.rb index bcc752a0..883b5288 100644 --- a/lib/orb/models/billable_metric.rb +++ b/lib/orb/models/billable_metric.rb @@ -56,6 +56,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::BillableMetric#status module Status extend Orb::Enum diff --git a/lib/orb/models/coupon.rb b/lib/orb/models/coupon.rb index 7c6acc57..ec9abc35 100644 --- a/lib/orb/models/coupon.rb +++ b/lib/orb/models/coupon.rb @@ -66,6 +66,7 @@ class Coupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Coupon#discount module Discount extend Orb::Union diff --git a/lib/orb/models/coupon_archive_params.rb b/lib/orb/models/coupon_archive_params.rb index 3f09d194..c7376d72 100644 --- a/lib/orb/models/coupon_archive_params.rb +++ b/lib/orb/models/coupon_archive_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Coupons#archive class CouponArchiveParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/coupon_create_params.rb b/lib/orb/models/coupon_create_params.rb index aafe5685..c7503993 100644 --- a/lib/orb/models/coupon_create_params.rb +++ b/lib/orb/models/coupon_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Coupons#create class CouponCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/coupon_fetch_params.rb b/lib/orb/models/coupon_fetch_params.rb index 3c327950..3fd91fa7 100644 --- a/lib/orb/models/coupon_fetch_params.rb +++ b/lib/orb/models/coupon_fetch_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Coupons#fetch class CouponFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/coupon_list_params.rb b/lib/orb/models/coupon_list_params.rb index 8dc123e5..9539e0e8 100644 --- a/lib/orb/models/coupon_list_params.rb +++ b/lib/orb/models/coupon_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Coupons#list class CouponListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/coupons/subscription_list_params.rb b/lib/orb/models/coupons/subscription_list_params.rb index acfccedb..5f1e5691 100644 --- a/lib/orb/models/coupons/subscription_list_params.rb +++ b/lib/orb/models/coupons/subscription_list_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Coupons + # @see Orb::Resources::Coupons::Subscriptions#list class SubscriptionListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/credit_note.rb b/lib/orb/models/credit_note.rb index 36ae5f39..b34c7a9f 100644 --- a/lib/orb/models/credit_note.rb +++ b/lib/orb/models/credit_note.rb @@ -145,6 +145,7 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::CreditNote#customer class Customer < Orb::BaseModel # @!attribute id # @@ -321,6 +322,7 @@ class Discount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::CreditNote::LineItem::Discount#discount_type module DiscountType extend Orb::Enum @@ -336,6 +338,7 @@ module DiscountType end end + # @see Orb::Models::CreditNote#maximum_amount_adjustment class MaximumAmountAdjustment < Orb::BaseModel # @!attribute amount_applied # @@ -377,6 +380,7 @@ class MaximumAmountAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::CreditNote::MaximumAmountAdjustment#discount_type module DiscountType extend Orb::Enum @@ -410,6 +414,7 @@ class AppliesToPrice < Orb::BaseModel end end + # @see Orb::Models::CreditNote#reason module Reason extend Orb::Enum @@ -425,6 +430,7 @@ module Reason # def self.values; end end + # @see Orb::Models::CreditNote#type module Type extend Orb::Enum @@ -477,6 +483,7 @@ class Discount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::CreditNote::Discount#discount_type module DiscountType extend Orb::Enum diff --git a/lib/orb/models/credit_note_create_params.rb b/lib/orb/models/credit_note_create_params.rb index 6c561197..1712eb71 100644 --- a/lib/orb/models/credit_note_create_params.rb +++ b/lib/orb/models/credit_note_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::CreditNotes#create class CreditNoteCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/credit_note_fetch_params.rb b/lib/orb/models/credit_note_fetch_params.rb index 305f35c9..263f9770 100644 --- a/lib/orb/models/credit_note_fetch_params.rb +++ b/lib/orb/models/credit_note_fetch_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::CreditNotes#fetch class CreditNoteFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/credit_note_list_params.rb b/lib/orb/models/credit_note_list_params.rb index 5b84f054..8b9efb93 100644 --- a/lib/orb/models/credit_note_list_params.rb +++ b/lib/orb/models/credit_note_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::CreditNotes#list class CreditNoteListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customer.rb b/lib/orb/models/customer.rb index 08f95373..f9bf0e73 100644 --- a/lib/orb/models/customer.rb +++ b/lib/orb/models/customer.rb @@ -314,6 +314,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customer#billing_address class BillingAddress < Orb::BaseModel # @!attribute city # @@ -358,6 +359,7 @@ class BillingAddress < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customer#hierarchy class Hierarchy < Orb::BaseModel # @!attribute children # @@ -399,6 +401,7 @@ class Child < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customer::Hierarchy#parent class Parent < Orb::BaseModel # @!attribute id # @@ -423,6 +426,8 @@ class Parent < Orb::BaseModel # 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. + # + # @see Orb::Models::Customer#payment_provider module PaymentProvider extend Orb::Enum @@ -439,6 +444,7 @@ module PaymentProvider # def self.values; end end + # @see Orb::Models::Customer#shipping_address class ShippingAddress < Orb::BaseModel # @!attribute city # @@ -483,6 +489,7 @@ class ShippingAddress < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customer#tax_id class TaxID < Orb::BaseModel # @!attribute country # @@ -614,6 +621,7 @@ class TaxID < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customer::TaxID#country module Country extend Orb::Enum @@ -703,6 +711,7 @@ module Country # def self.values; end end + # @see Orb::Models::Customer::TaxID#type module Type extend Orb::Enum @@ -786,6 +795,7 @@ module Type end end + # @see Orb::Models::Customer#accounting_sync_configuration class AccountingSyncConfiguration < Orb::BaseModel # @!attribute accounting_providers # @@ -826,6 +836,7 @@ class AccountingProvider < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider#provider_type module ProviderType extend Orb::Enum @@ -841,6 +852,7 @@ module ProviderType end end + # @see Orb::Models::Customer#reporting_configuration class ReportingConfiguration < Orb::BaseModel # @!attribute exempt # diff --git a/lib/orb/models/customer_create_params.rb b/lib/orb/models/customer_create_params.rb index c41ed123..8351d4e0 100644 --- a/lib/orb/models/customer_create_params.rb +++ b/lib/orb/models/customer_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#create class CustomerCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -664,6 +665,7 @@ class TaxID < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::CustomerCreateParams::TaxID#country module Country extend Orb::Enum @@ -753,6 +755,7 @@ module Country # def self.values; end end + # @see Orb::Models::CustomerCreateParams::TaxID#type module Type extend Orb::Enum diff --git a/lib/orb/models/customer_delete_params.rb b/lib/orb/models/customer_delete_params.rb index fc70ff50..2db126bd 100644 --- a/lib/orb/models/customer_delete_params.rb +++ b/lib/orb/models/customer_delete_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#delete class CustomerDeleteParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customer_fetch_by_external_id_params.rb b/lib/orb/models/customer_fetch_by_external_id_params.rb index 5ed7ee32..0294c8c9 100644 --- a/lib/orb/models/customer_fetch_by_external_id_params.rb +++ b/lib/orb/models/customer_fetch_by_external_id_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#fetch_by_external_id class CustomerFetchByExternalIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customer_fetch_params.rb b/lib/orb/models/customer_fetch_params.rb index 339f38ff..31bea648 100644 --- a/lib/orb/models/customer_fetch_params.rb +++ b/lib/orb/models/customer_fetch_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#fetch class CustomerFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customer_list_params.rb b/lib/orb/models/customer_list_params.rb index ad236606..e2a667fe 100644 --- a/lib/orb/models/customer_list_params.rb +++ b/lib/orb/models/customer_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#list class CustomerListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb b/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb index 0059b05f..641359fb 100644 --- a/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +++ b/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#sync_payment_methods_from_gateway_by_external_customer_id class CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb b/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb index 93514b0f..dd0855aa 100644 --- a/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +++ b/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#sync_payment_methods_from_gateway class CustomerSyncPaymentMethodsFromGatewayParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 0565158d..073af606 100644 --- a/lib/orb/models/customer_update_by_external_id_params.rb +++ b/lib/orb/models/customer_update_by_external_id_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#update_by_external_id class CustomerUpdateByExternalIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -669,6 +670,7 @@ class TaxID < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#country module Country extend Orb::Enum @@ -758,6 +760,7 @@ module Country # def self.values; end end + # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#type module Type extend Orb::Enum diff --git a/lib/orb/models/customer_update_params.rb b/lib/orb/models/customer_update_params.rb index a5bdcebf..959eef3d 100644 --- a/lib/orb/models/customer_update_params.rb +++ b/lib/orb/models/customer_update_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#update class CustomerUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -659,6 +660,7 @@ class TaxID < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::CustomerUpdateParams::TaxID#country module Country extend Orb::Enum @@ -748,6 +750,7 @@ module Country # def self.values; end end + # @see Orb::Models::CustomerUpdateParams::TaxID#type module Type extend Orb::Enum diff --git a/lib/orb/models/customers/balance_transaction_create_params.rb b/lib/orb/models/customers/balance_transaction_create_params.rb index 8f8dc5c0..711dbee9 100644 --- a/lib/orb/models/customers/balance_transaction_create_params.rb +++ b/lib/orb/models/customers/balance_transaction_create_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::BalanceTransactions#create class BalanceTransactionCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customers/balance_transaction_create_response.rb b/lib/orb/models/customers/balance_transaction_create_response.rb index d314bed3..872bb78c 100644 --- a/lib/orb/models/customers/balance_transaction_create_response.rb +++ b/lib/orb/models/customers/balance_transaction_create_response.rb @@ -94,6 +94,7 @@ class BalanceTransactionCreateResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::BalanceTransactionCreateResponse#action module Action extend Orb::Enum @@ -114,6 +115,7 @@ module Action # def self.values; end end + # @see Orb::Models::Customers::BalanceTransactionCreateResponse#credit_note class CreditNote < Orb::BaseModel # @!attribute id # The id of the Credit note @@ -129,6 +131,7 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::BalanceTransactionCreateResponse#invoice class Invoice < Orb::BaseModel # @!attribute id # The Invoice id @@ -144,6 +147,7 @@ class Invoice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::BalanceTransactionCreateResponse#type module Type extend Orb::Enum diff --git a/lib/orb/models/customers/balance_transaction_list_params.rb b/lib/orb/models/customers/balance_transaction_list_params.rb index 09471c6e..160620a6 100644 --- a/lib/orb/models/customers/balance_transaction_list_params.rb +++ b/lib/orb/models/customers/balance_transaction_list_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::BalanceTransactions#list class BalanceTransactionListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customers/balance_transaction_list_response.rb b/lib/orb/models/customers/balance_transaction_list_response.rb index e6d5e900..f942a045 100644 --- a/lib/orb/models/customers/balance_transaction_list_response.rb +++ b/lib/orb/models/customers/balance_transaction_list_response.rb @@ -94,6 +94,7 @@ class BalanceTransactionListResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::BalanceTransactionListResponse#action module Action extend Orb::Enum @@ -114,6 +115,7 @@ module Action # def self.values; end end + # @see Orb::Models::Customers::BalanceTransactionListResponse#credit_note class CreditNote < Orb::BaseModel # @!attribute id # The id of the Credit note @@ -129,6 +131,7 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::BalanceTransactionListResponse#invoice class Invoice < Orb::BaseModel # @!attribute id # The Invoice id @@ -144,6 +147,7 @@ class Invoice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::BalanceTransactionListResponse#type module Type extend Orb::Enum 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 2a8aa036..35cb32f3 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 @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::Costs#list_by_external_id class CostListByExternalIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customers/cost_list_params.rb b/lib/orb/models/customers/cost_list_params.rb index 10ab8d4b..5ff207a8 100644 --- a/lib/orb/models/customers/cost_list_params.rb +++ b/lib/orb/models/customers/cost_list_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::Costs#list class CostListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 dc9d0fbe..88399251 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 @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::Credits#list_by_external_id class CreditListByExternalIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customers/credit_list_by_external_id_response.rb b/lib/orb/models/customers/credit_list_by_external_id_response.rb index 2742e64b..7141b0b9 100644 --- a/lib/orb/models/customers/credit_list_by_external_id_response.rb +++ b/lib/orb/models/customers/credit_list_by_external_id_response.rb @@ -52,6 +52,7 @@ class CreditListByExternalIDResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::CreditListByExternalIDResponse#status module Status extend Orb::Enum diff --git a/lib/orb/models/customers/credit_list_params.rb b/lib/orb/models/customers/credit_list_params.rb index c1986b2e..0db20d3b 100644 --- a/lib/orb/models/customers/credit_list_params.rb +++ b/lib/orb/models/customers/credit_list_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::Credits#list class CreditListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customers/credit_list_response.rb b/lib/orb/models/customers/credit_list_response.rb index 68f9cbba..b1baf1ca 100644 --- a/lib/orb/models/customers/credit_list_response.rb +++ b/lib/orb/models/customers/credit_list_response.rb @@ -52,6 +52,7 @@ class CreditListResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::CreditListResponse#status module Status extend Orb::Enum 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 a0339fe9..c3080a73 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 @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::Ledger#create_entry_by_external_id class LedgerCreateEntryByExternalIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 ca6ea74b..db32c752 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 @@ -141,6 +141,7 @@ class IncrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -167,6 +168,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -187,6 +189,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -331,6 +334,7 @@ class DecrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -357,6 +361,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -377,6 +382,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -507,6 +513,7 @@ class ExpirationChangeLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -533,6 +540,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -553,6 +561,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -676,6 +685,7 @@ class CreditBlockExpiryLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -702,6 +712,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -722,6 +733,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -859,6 +871,7 @@ class VoidLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -885,6 +898,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -905,6 +919,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -1049,6 +1064,7 @@ class VoidInitiatedLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1075,6 +1091,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -1095,6 +1112,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -1218,6 +1236,7 @@ class AmendmentLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1244,6 +1263,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -1264,6 +1284,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#entry_status module EntryStatus extend Orb::Enum 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 e78a9ad4..4c7b1c52 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_params.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_params.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::Ledger#create_entry class LedgerCreateEntryParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 94d772de..44dc7eb7 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_response.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_response.rb @@ -140,6 +140,7 @@ class IncrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -166,6 +167,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -186,6 +188,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -330,6 +333,7 @@ class DecrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -356,6 +360,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -376,6 +381,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -506,6 +512,7 @@ class ExpirationChangeLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -532,6 +539,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -552,6 +560,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -675,6 +684,7 @@ class CreditBlockExpiryLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -701,6 +711,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -721,6 +732,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -858,6 +870,7 @@ class VoidLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -884,6 +897,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -904,6 +918,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -1048,6 +1063,7 @@ class VoidInitiatedLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1074,6 +1090,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -1094,6 +1111,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -1217,6 +1235,7 @@ class AmendmentLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1243,6 +1262,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -1263,6 +1283,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry#entry_status module EntryStatus extend Orb::Enum 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 45853c37..10cf3d9d 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 @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::Ledger#list_by_external_id class LedgerListByExternalIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 ba493e38..b2ba4d0a 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 @@ -140,6 +140,7 @@ class IncrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -166,6 +167,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -186,6 +188,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -330,6 +333,7 @@ class DecrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -356,6 +360,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -376,6 +381,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -506,6 +512,7 @@ class ExpirationChangeLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -532,6 +539,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -552,6 +560,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -675,6 +684,7 @@ class CreditBlockExpiryLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -701,6 +711,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -721,6 +732,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -858,6 +870,7 @@ class VoidLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -884,6 +897,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -904,6 +918,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -1048,6 +1063,7 @@ class VoidInitiatedLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1074,6 +1090,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -1094,6 +1111,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -1217,6 +1235,7 @@ class AmendmentLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1243,6 +1262,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -1263,6 +1283,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#entry_status module EntryStatus extend Orb::Enum diff --git a/lib/orb/models/customers/credits/ledger_list_params.rb b/lib/orb/models/customers/credits/ledger_list_params.rb index 772ed685..380fcd82 100644 --- a/lib/orb/models/customers/credits/ledger_list_params.rb +++ b/lib/orb/models/customers/credits/ledger_list_params.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::Ledger#list class LedgerListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customers/credits/ledger_list_response.rb b/lib/orb/models/customers/credits/ledger_list_response.rb index deb87cdd..03b4bfa0 100644 --- a/lib/orb/models/customers/credits/ledger_list_response.rb +++ b/lib/orb/models/customers/credits/ledger_list_response.rb @@ -137,6 +137,7 @@ class IncrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -163,6 +164,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -183,6 +185,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -327,6 +330,7 @@ class DecrementLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -353,6 +357,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -373,6 +378,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -503,6 +509,7 @@ class ExpirationChangeLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -529,6 +536,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -549,6 +557,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -672,6 +681,7 @@ class CreditBlockExpiryLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -698,6 +708,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -718,6 +729,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -854,6 +866,7 @@ class VoidLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -880,6 +893,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -900,6 +914,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -1044,6 +1059,7 @@ class VoidInitiatedLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1070,6 +1086,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -1090,6 +1107,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry#entry_status module EntryStatus extend Orb::Enum @@ -1213,6 +1231,7 @@ class AmendmentLedgerEntry < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry#credit_block class CreditBlock < Orb::BaseModel # @!attribute id # @@ -1239,6 +1258,7 @@ class CreditBlock < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry#customer class Customer < Orb::BaseModel # @!attribute id # @@ -1259,6 +1279,7 @@ class Customer < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry#entry_status module EntryStatus extend Orb::Enum 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 9ea7b86c..8e16bc7b 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 @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#create_by_external_id class TopUpCreateByExternalIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 fea14743..72cc678e 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 @@ -84,6 +84,7 @@ class TopUpCreateByExternalIDResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse#invoice_settings class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's @@ -131,6 +132,8 @@ class InvoiceSettings < Orb::BaseModel end # The unit of expires_after. + # + # @see Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse#expires_after_unit module ExpiresAfterUnit extend Orb::Enum 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 4db3e3b4..f347c812 100644 --- a/lib/orb/models/customers/credits/top_up_create_params.rb +++ b/lib/orb/models/customers/credits/top_up_create_params.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#create class TopUpCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 525f6315..8f3e048b 100644 --- a/lib/orb/models/customers/credits/top_up_create_response.rb +++ b/lib/orb/models/customers/credits/top_up_create_response.rb @@ -83,6 +83,7 @@ class TopUpCreateResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::TopUpCreateResponse#invoice_settings class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's @@ -130,6 +131,8 @@ class InvoiceSettings < Orb::BaseModel end # The unit of expires_after. + # + # @see Orb::Models::Customers::Credits::TopUpCreateResponse#expires_after_unit module ExpiresAfterUnit extend Orb::Enum diff --git a/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb b/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb index a1d8de8f..496f6a10 100644 --- a/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +++ b/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#delete_by_external_id class TopUpDeleteByExternalIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/customers/credits/top_up_delete_params.rb b/lib/orb/models/customers/credits/top_up_delete_params.rb index cf6ae53b..e844f1c3 100644 --- a/lib/orb/models/customers/credits/top_up_delete_params.rb +++ b/lib/orb/models/customers/credits/top_up_delete_params.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#delete class TopUpDeleteParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 68cc0348..c0adc4c5 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 @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#list_by_external_id class TopUpListByExternalIDParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 5752ecd1..e4b74f74 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 @@ -84,6 +84,7 @@ class TopUpListByExternalIDResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::TopUpListByExternalIDResponse#invoice_settings class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's @@ -131,6 +132,8 @@ class InvoiceSettings < Orb::BaseModel end # The unit of expires_after. + # + # @see Orb::Models::Customers::Credits::TopUpListByExternalIDResponse#expires_after_unit module ExpiresAfterUnit extend Orb::Enum 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 7223e6ae..b463113b 100644 --- a/lib/orb/models/customers/credits/top_up_list_params.rb +++ b/lib/orb/models/customers/credits/top_up_list_params.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#list class TopUpListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 07c8e4ff..5d605656 100644 --- a/lib/orb/models/customers/credits/top_up_list_response.rb +++ b/lib/orb/models/customers/credits/top_up_list_response.rb @@ -83,6 +83,7 @@ class TopUpListResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Customers::Credits::TopUpListResponse#invoice_settings class InvoiceSettings < Orb::BaseModel # @!attribute auto_collection # Whether the credits purchase invoice should auto collect with the customer's @@ -130,6 +131,8 @@ class InvoiceSettings < Orb::BaseModel end # The unit of expires_after. + # + # @see Orb::Models::Customers::Credits::TopUpListResponse#expires_after_unit module ExpiresAfterUnit extend Orb::Enum diff --git a/lib/orb/models/dimensional_price_group_create_params.rb b/lib/orb/models/dimensional_price_group_create_params.rb index 1f645c5b..5d810955 100644 --- a/lib/orb/models/dimensional_price_group_create_params.rb +++ b/lib/orb/models/dimensional_price_group_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::DimensionalPriceGroups#create class DimensionalPriceGroupCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/dimensional_price_group_list_params.rb b/lib/orb/models/dimensional_price_group_list_params.rb index 50557ca6..516e32c7 100644 --- a/lib/orb/models/dimensional_price_group_list_params.rb +++ b/lib/orb/models/dimensional_price_group_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::DimensionalPriceGroups#list class DimensionalPriceGroupListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/dimensional_price_group_retrieve_params.rb b/lib/orb/models/dimensional_price_group_retrieve_params.rb index 5701b432..270f65f2 100644 --- a/lib/orb/models/dimensional_price_group_retrieve_params.rb +++ b/lib/orb/models/dimensional_price_group_retrieve_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::DimensionalPriceGroups#retrieve class DimensionalPriceGroupRetrieveParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb b/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb index c6f8ee39..81d8cc7b 100644 --- a/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +++ b/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb @@ -3,6 +3,7 @@ module Orb module Models module DimensionalPriceGroups + # @see Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID#retrieve class ExternalDimensionalPriceGroupIDRetrieveParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/event_deprecate_params.rb b/lib/orb/models/event_deprecate_params.rb index 90eeb445..55b0ef63 100644 --- a/lib/orb/models/event_deprecate_params.rb +++ b/lib/orb/models/event_deprecate_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Events#deprecate class EventDeprecateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/event_ingest_params.rb b/lib/orb/models/event_ingest_params.rb index f4de3ebc..eb74c185 100644 --- a/lib/orb/models/event_ingest_params.rb +++ b/lib/orb/models/event_ingest_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Events#ingest class EventIngestParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/event_ingest_response.rb b/lib/orb/models/event_ingest_response.rb index ddfb6c81..a2e7e0c9 100644 --- a/lib/orb/models/event_ingest_response.rb +++ b/lib/orb/models/event_ingest_response.rb @@ -48,6 +48,7 @@ class ValidationFailed < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::EventIngestResponse#debug class Debug < Orb::BaseModel # @!attribute duplicate # diff --git a/lib/orb/models/event_search_params.rb b/lib/orb/models/event_search_params.rb index 134be023..b3f6aa85 100644 --- a/lib/orb/models/event_search_params.rb +++ b/lib/orb/models/event_search_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Events#search class EventSearchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/event_update_params.rb b/lib/orb/models/event_update_params.rb index 0a2f794e..f3dd6cd5 100644 --- a/lib/orb/models/event_update_params.rb +++ b/lib/orb/models/event_update_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Events#update class EventUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/events/backfill_close_params.rb b/lib/orb/models/events/backfill_close_params.rb index 6f82c48f..03bf5c2c 100644 --- a/lib/orb/models/events/backfill_close_params.rb +++ b/lib/orb/models/events/backfill_close_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#close class BackfillCloseParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/events/backfill_close_response.rb b/lib/orb/models/events/backfill_close_response.rb index 26bb80d9..ee69ee98 100644 --- a/lib/orb/models/events/backfill_close_response.rb +++ b/lib/orb/models/events/backfill_close_response.rb @@ -108,6 +108,8 @@ class BackfillCloseResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The status of the backfill. + # + # @see Orb::Models::Events::BackfillCloseResponse#status module Status extend Orb::Enum diff --git a/lib/orb/models/events/backfill_create_params.rb b/lib/orb/models/events/backfill_create_params.rb index f97a02a4..2daaa39c 100644 --- a/lib/orb/models/events/backfill_create_params.rb +++ b/lib/orb/models/events/backfill_create_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#create class BackfillCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/events/backfill_create_response.rb b/lib/orb/models/events/backfill_create_response.rb index 749d46cb..24b9b89f 100644 --- a/lib/orb/models/events/backfill_create_response.rb +++ b/lib/orb/models/events/backfill_create_response.rb @@ -108,6 +108,8 @@ class BackfillCreateResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The status of the backfill. + # + # @see Orb::Models::Events::BackfillCreateResponse#status module Status extend Orb::Enum diff --git a/lib/orb/models/events/backfill_fetch_params.rb b/lib/orb/models/events/backfill_fetch_params.rb index 1f87bbac..13567d22 100644 --- a/lib/orb/models/events/backfill_fetch_params.rb +++ b/lib/orb/models/events/backfill_fetch_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#fetch class BackfillFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/events/backfill_fetch_response.rb b/lib/orb/models/events/backfill_fetch_response.rb index 8fe972d0..7a05b477 100644 --- a/lib/orb/models/events/backfill_fetch_response.rb +++ b/lib/orb/models/events/backfill_fetch_response.rb @@ -108,6 +108,8 @@ class BackfillFetchResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The status of the backfill. + # + # @see Orb::Models::Events::BackfillFetchResponse#status module Status extend Orb::Enum diff --git a/lib/orb/models/events/backfill_list_params.rb b/lib/orb/models/events/backfill_list_params.rb index 4fa393cd..c88405dc 100644 --- a/lib/orb/models/events/backfill_list_params.rb +++ b/lib/orb/models/events/backfill_list_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#list class BackfillListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/events/backfill_list_response.rb b/lib/orb/models/events/backfill_list_response.rb index 158bb6b6..29c0618b 100644 --- a/lib/orb/models/events/backfill_list_response.rb +++ b/lib/orb/models/events/backfill_list_response.rb @@ -108,6 +108,8 @@ class BackfillListResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The status of the backfill. + # + # @see Orb::Models::Events::BackfillListResponse#status module Status extend Orb::Enum diff --git a/lib/orb/models/events/backfill_revert_params.rb b/lib/orb/models/events/backfill_revert_params.rb index 625e119b..07dd510f 100644 --- a/lib/orb/models/events/backfill_revert_params.rb +++ b/lib/orb/models/events/backfill_revert_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#revert class BackfillRevertParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/events/backfill_revert_response.rb b/lib/orb/models/events/backfill_revert_response.rb index 1cadbeb4..a378ab22 100644 --- a/lib/orb/models/events/backfill_revert_response.rb +++ b/lib/orb/models/events/backfill_revert_response.rb @@ -108,6 +108,8 @@ class BackfillRevertResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The status of the backfill. + # + # @see Orb::Models::Events::BackfillRevertResponse#status module Status extend Orb::Enum diff --git a/lib/orb/models/events/volume_list_params.rb b/lib/orb/models/events/volume_list_params.rb index 1796f42a..70ff450c 100644 --- a/lib/orb/models/events/volume_list_params.rb +++ b/lib/orb/models/events/volume_list_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Volume#list class VolumeListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/invoice.rb b/lib/orb/models/invoice.rb index 3c36c0fb..3b0e02b3 100644 --- a/lib/orb/models/invoice.rb +++ b/lib/orb/models/invoice.rb @@ -461,6 +461,7 @@ class Invoice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Invoice#auto_collection class AutoCollection < Orb::BaseModel # @!attribute enabled # True only if auto-collection is enabled for this invoice. @@ -504,6 +505,7 @@ class AutoCollection < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Invoice#billing_address class BillingAddress < Orb::BaseModel # @!attribute city # @@ -601,6 +603,7 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Invoice#customer class Customer < Orb::BaseModel # @!attribute id # @@ -710,6 +713,7 @@ class CustomerBalanceTransaction < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Invoice::CustomerBalanceTransaction#action module Action extend Orb::Enum @@ -730,6 +734,7 @@ module Action # def self.values; end end + # @see Orb::Models::Invoice::CustomerBalanceTransaction#credit_note class CreditNote < Orb::BaseModel # @!attribute id # The id of the Credit note @@ -745,6 +750,7 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Invoice::CustomerBalanceTransaction#invoice class Invoice < Orb::BaseModel # @!attribute id # The Invoice id @@ -760,6 +766,7 @@ class Invoice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Invoice::CustomerBalanceTransaction#type module Type extend Orb::Enum @@ -774,6 +781,7 @@ module Type end end + # @see Orb::Models::Invoice#customer_tax_id class CustomerTaxID < Orb::BaseModel # @!attribute country # @@ -905,6 +913,7 @@ class CustomerTaxID < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Invoice::CustomerTaxID#country module Country extend Orb::Enum @@ -994,6 +1003,7 @@ module Country # def self.values; end end + # @see Orb::Models::Invoice::CustomerTaxID#type module Type extend Orb::Enum @@ -1077,6 +1087,7 @@ module Type end end + # @see Orb::Models::Invoice#invoice_source module InvoiceSource extend Orb::Enum @@ -1666,6 +1677,8 @@ class MonetaryMaximumAdjustment < Orb::BaseModel end # @deprecated + # + # @see Orb::Models::Invoice::LineItem#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -1692,6 +1705,8 @@ class Maximum < Orb::BaseModel end # @deprecated + # + # @see Orb::Models::Invoice::LineItem#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -1775,6 +1790,7 @@ class MatrixSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem#grouping class Grouping < Orb::BaseModel # @!attribute key # @@ -1796,6 +1812,7 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute dimension_values # The ordered dimension values for this line item. @@ -1858,6 +1875,7 @@ class TierSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem#grouping class Grouping < Orb::BaseModel # @!attribute key # @@ -1879,6 +1897,7 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem#tier_config class TierConfig < Orb::BaseModel # @!attribute first_unit # @@ -1946,6 +1965,7 @@ class OtherSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem#grouping class Grouping < Orb::BaseModel # @!attribute key # @@ -2003,6 +2023,7 @@ class TaxAmount < Orb::BaseModel end end + # @see Orb::Models::Invoice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -2026,6 +2047,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Invoice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -2099,6 +2121,8 @@ class PaymentAttempt < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The payment provider that attempted to collect the payment. + # + # @see Orb::Models::Invoice::PaymentAttempt#payment_provider module PaymentProvider extend Orb::Enum @@ -2112,6 +2136,7 @@ module PaymentProvider end end + # @see Orb::Models::Invoice#shipping_address class ShippingAddress < Orb::BaseModel # @!attribute city # @@ -2156,6 +2181,7 @@ class ShippingAddress < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Invoice#status module Status extend Orb::Enum @@ -2172,6 +2198,7 @@ module Status # def self.values; end end + # @see Orb::Models::Invoice#subscription class Subscription < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/invoice_create_params.rb b/lib/orb/models/invoice_create_params.rb index 3e28bb9e..8c58555e 100644 --- a/lib/orb/models/invoice_create_params.rb +++ b/lib/orb/models/invoice_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#create class InvoiceCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -165,6 +166,7 @@ class LineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceCreateParams::LineItem#model_type module ModelType extend Orb::Enum @@ -177,6 +179,7 @@ module ModelType # def self.values; end end + # @see Orb::Models::InvoiceCreateParams::LineItem#unit_config class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage diff --git a/lib/orb/models/invoice_fetch_params.rb b/lib/orb/models/invoice_fetch_params.rb index 31bbf9cf..92c84225 100644 --- a/lib/orb/models/invoice_fetch_params.rb +++ b/lib/orb/models/invoice_fetch_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#fetch class InvoiceFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/invoice_fetch_upcoming_params.rb b/lib/orb/models/invoice_fetch_upcoming_params.rb index 5ee26b5c..80b10907 100644 --- a/lib/orb/models/invoice_fetch_upcoming_params.rb +++ b/lib/orb/models/invoice_fetch_upcoming_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#fetch_upcoming class InvoiceFetchUpcomingParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/invoice_fetch_upcoming_response.rb b/lib/orb/models/invoice_fetch_upcoming_response.rb index c3963efe..321a50f3 100644 --- a/lib/orb/models/invoice_fetch_upcoming_response.rb +++ b/lib/orb/models/invoice_fetch_upcoming_response.rb @@ -455,6 +455,7 @@ class InvoiceFetchUpcomingResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceFetchUpcomingResponse#auto_collection class AutoCollection < Orb::BaseModel # @!attribute enabled # True only if auto-collection is enabled for this invoice. @@ -498,6 +499,7 @@ class AutoCollection < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceFetchUpcomingResponse#billing_address class BillingAddress < Orb::BaseModel # @!attribute city # @@ -595,6 +597,7 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceFetchUpcomingResponse#customer class Customer < Orb::BaseModel # @!attribute id # @@ -709,6 +712,7 @@ class CustomerBalanceTransaction < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#action module Action extend Orb::Enum @@ -729,6 +733,7 @@ module Action # def self.values; end end + # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#credit_note class CreditNote < Orb::BaseModel # @!attribute id # The id of the Credit note @@ -744,6 +749,7 @@ class CreditNote < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#invoice class Invoice < Orb::BaseModel # @!attribute id # The Invoice id @@ -759,6 +765,7 @@ class Invoice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#type module Type extend Orb::Enum @@ -773,6 +780,7 @@ module Type end end + # @see Orb::Models::InvoiceFetchUpcomingResponse#customer_tax_id class CustomerTaxID < Orb::BaseModel # @!attribute country # @@ -904,6 +912,7 @@ class CustomerTaxID < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#country module Country extend Orb::Enum @@ -993,6 +1002,7 @@ module Country # def self.values; end end + # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#type module Type extend Orb::Enum @@ -1076,6 +1086,7 @@ module Type end end + # @see Orb::Models::InvoiceFetchUpcomingResponse#invoice_source module InvoiceSource extend Orb::Enum @@ -1669,6 +1680,8 @@ class MonetaryMaximumAdjustment < Orb::BaseModel end # @deprecated + # + # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -1695,6 +1708,8 @@ class Maximum < Orb::BaseModel end # @deprecated + # + # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -1780,6 +1795,7 @@ class MatrixSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem#grouping class Grouping < Orb::BaseModel # @!attribute key # @@ -1801,6 +1817,7 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute dimension_values # The ordered dimension values for this line item. @@ -1864,6 +1881,7 @@ class TierSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem#grouping class Grouping < Orb::BaseModel # @!attribute key # @@ -1885,6 +1903,7 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem#tier_config class TierConfig < Orb::BaseModel # @!attribute first_unit # @@ -1952,6 +1971,7 @@ class OtherSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem#grouping class Grouping < Orb::BaseModel # @!attribute key # @@ -2009,6 +2029,7 @@ class TaxAmount < Orb::BaseModel end end + # @see Orb::Models::InvoiceFetchUpcomingResponse#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -2032,6 +2053,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceFetchUpcomingResponse#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -2107,6 +2129,8 @@ class PaymentAttempt < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The payment provider that attempted to collect the payment. + # + # @see Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt#payment_provider module PaymentProvider extend Orb::Enum @@ -2120,6 +2144,7 @@ module PaymentProvider end end + # @see Orb::Models::InvoiceFetchUpcomingResponse#shipping_address class ShippingAddress < Orb::BaseModel # @!attribute city # @@ -2164,6 +2189,7 @@ class ShippingAddress < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceFetchUpcomingResponse#status module Status extend Orb::Enum @@ -2180,6 +2206,7 @@ module Status # def self.values; end end + # @see Orb::Models::InvoiceFetchUpcomingResponse#subscription class Subscription < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/invoice_issue_params.rb b/lib/orb/models/invoice_issue_params.rb index 4784778e..df4a08d7 100644 --- a/lib/orb/models/invoice_issue_params.rb +++ b/lib/orb/models/invoice_issue_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#issue class InvoiceIssueParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/invoice_line_item_create_params.rb b/lib/orb/models/invoice_line_item_create_params.rb index 3fa820ac..d3821f88 100644 --- a/lib/orb/models/invoice_line_item_create_params.rb +++ b/lib/orb/models/invoice_line_item_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::InvoiceLineItems#create class InvoiceLineItemCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/invoice_line_item_create_response.rb b/lib/orb/models/invoice_line_item_create_response.rb index 9143509a..1abed7ec 100644 --- a/lib/orb/models/invoice_line_item_create_response.rb +++ b/lib/orb/models/invoice_line_item_create_response.rb @@ -578,6 +578,8 @@ class MonetaryMaximumAdjustment < Orb::BaseModel end # @deprecated + # + # @see Orb::Models::InvoiceLineItemCreateResponse#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -604,6 +606,8 @@ class Maximum < Orb::BaseModel end # @deprecated + # + # @see Orb::Models::InvoiceLineItemCreateResponse#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -687,6 +691,7 @@ class MatrixSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem#grouping class Grouping < Orb::BaseModel # @!attribute key # @@ -708,6 +713,7 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute dimension_values # The ordered dimension values for this line item. @@ -771,6 +777,7 @@ class TierSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem#grouping class Grouping < Orb::BaseModel # @!attribute key # @@ -792,6 +799,7 @@ class Grouping < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem#tier_config class TierConfig < Orb::BaseModel # @!attribute first_unit # @@ -859,6 +867,7 @@ class OtherSubLineItem < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem#grouping class Grouping < Orb::BaseModel # @!attribute key # diff --git a/lib/orb/models/invoice_list_params.rb b/lib/orb/models/invoice_list_params.rb index 85841890..8c5e7de5 100644 --- a/lib/orb/models/invoice_list_params.rb +++ b/lib/orb/models/invoice_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#list class InvoiceListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/invoice_mark_paid_params.rb b/lib/orb/models/invoice_mark_paid_params.rb index 66af2533..848785ac 100644 --- a/lib/orb/models/invoice_mark_paid_params.rb +++ b/lib/orb/models/invoice_mark_paid_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#mark_paid class InvoiceMarkPaidParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/invoice_pay_params.rb b/lib/orb/models/invoice_pay_params.rb index 29b0fad0..ebc35751 100644 --- a/lib/orb/models/invoice_pay_params.rb +++ b/lib/orb/models/invoice_pay_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#pay class InvoicePayParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/invoice_update_params.rb b/lib/orb/models/invoice_update_params.rb index b725c57e..40b13e17 100644 --- a/lib/orb/models/invoice_update_params.rb +++ b/lib/orb/models/invoice_update_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#update class InvoiceUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/invoice_void_params.rb b/lib/orb/models/invoice_void_params.rb index 3f6ad301..1584b947 100644 --- a/lib/orb/models/invoice_void_params.rb +++ b/lib/orb/models/invoice_void_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#void class InvoiceVoidParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/item.rb b/lib/orb/models/item.rb index 1a244522..647b06c6 100644 --- a/lib/orb/models/item.rb +++ b/lib/orb/models/item.rb @@ -57,6 +57,7 @@ class ExternalConnection < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Item::ExternalConnection#external_connection_name module ExternalConnectionName extend Orb::Enum diff --git a/lib/orb/models/item_create_params.rb b/lib/orb/models/item_create_params.rb index fe1886fd..52c95deb 100644 --- a/lib/orb/models/item_create_params.rb +++ b/lib/orb/models/item_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Items#create class ItemCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/item_fetch_params.rb b/lib/orb/models/item_fetch_params.rb index a9ef2520..07c6e96f 100644 --- a/lib/orb/models/item_fetch_params.rb +++ b/lib/orb/models/item_fetch_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Items#fetch class ItemFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/item_list_params.rb b/lib/orb/models/item_list_params.rb index 70c95e48..f1603d26 100644 --- a/lib/orb/models/item_list_params.rb +++ b/lib/orb/models/item_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Items#list class ItemListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/item_update_params.rb b/lib/orb/models/item_update_params.rb index 12570552..df9d50fd 100644 --- a/lib/orb/models/item_update_params.rb +++ b/lib/orb/models/item_update_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Items#update class ItemUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -48,6 +49,7 @@ class ExternalConnection < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::ItemUpdateParams::ExternalConnection#external_connection_name module ExternalConnectionName extend Orb::Enum diff --git a/lib/orb/models/metric_create_params.rb b/lib/orb/models/metric_create_params.rb index 4bef1c0d..5ba673bf 100644 --- a/lib/orb/models/metric_create_params.rb +++ b/lib/orb/models/metric_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Metrics#create class MetricCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/metric_fetch_params.rb b/lib/orb/models/metric_fetch_params.rb index 17015501..d8f31e18 100644 --- a/lib/orb/models/metric_fetch_params.rb +++ b/lib/orb/models/metric_fetch_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Metrics#fetch class MetricFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/metric_list_params.rb b/lib/orb/models/metric_list_params.rb index 93ee6f61..670c3b43 100644 --- a/lib/orb/models/metric_list_params.rb +++ b/lib/orb/models/metric_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Metrics#list class MetricListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/metric_update_params.rb b/lib/orb/models/metric_update_params.rb index 836e290f..c12ea97f 100644 --- a/lib/orb/models/metric_update_params.rb +++ b/lib/orb/models/metric_update_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Metrics#update class MetricUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/percentage_discount.rb b/lib/orb/models/percentage_discount.rb index 91d8f1a2..23183f8e 100644 --- a/lib/orb/models/percentage_discount.rb +++ b/lib/orb/models/percentage_discount.rb @@ -37,6 +37,7 @@ class PercentageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::PercentageDiscount#discount_type module DiscountType extend Orb::Enum diff --git a/lib/orb/models/plan.rb b/lib/orb/models/plan.rb index b632c8db..312b38d4 100644 --- a/lib/orb/models/plan.rb +++ b/lib/orb/models/plan.rb @@ -578,6 +578,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel # def self.variants; end end + # @see Orb::Models::Plan#base_plan class BasePlan < Orb::BaseModel # @!attribute id # @@ -607,6 +608,7 @@ class BasePlan < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Plan#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -630,6 +632,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Plan#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -744,6 +747,7 @@ class PlanPhase < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Plan::PlanPhase#duration_unit module DurationUnit extend Orb::Enum @@ -760,6 +764,7 @@ module DurationUnit # def self.values; end end + # @see Orb::Models::Plan::PlanPhase#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -783,6 +788,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Plan::PlanPhase#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -807,6 +813,7 @@ class Minimum < Orb::BaseModel end end + # @see Orb::Models::Plan#product class Product < Orb::BaseModel # @!attribute id # @@ -833,6 +840,7 @@ class Product < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Plan#status module Status extend Orb::Enum @@ -847,6 +855,7 @@ module Status # def self.values; end end + # @see Orb::Models::Plan#trial_config class TrialConfig < Orb::BaseModel # @!attribute trial_period # @@ -866,6 +875,7 @@ class TrialConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Plan::TrialConfig#trial_period_unit module TrialPeriodUnit extend Orb::Enum diff --git a/lib/orb/models/plan_create_params.rb b/lib/orb/models/plan_create_params.rb index 55dcecd7..d01072d1 100644 --- a/lib/orb/models/plan_create_params.rb +++ b/lib/orb/models/plan_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Plans#create class PlanCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -299,6 +300,8 @@ class NewPlanUnitPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice#cadence module Cadence extend Orb::Enum @@ -316,6 +319,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice#unit_config class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -331,6 +335,7 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -357,6 +362,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -371,6 +378,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -397,6 +405,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -554,6 +564,8 @@ class NewPlanPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice#cadence module Cadence extend Orb::Enum @@ -571,6 +583,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice#package_config class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -594,6 +607,7 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -620,6 +634,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -634,6 +650,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -660,6 +677,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -817,6 +836,8 @@ class NewPlanMatrixPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice#cadence module Cadence extend Orb::Enum @@ -834,6 +855,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -888,6 +910,7 @@ class MatrixValue < Orb::BaseModel end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -914,6 +937,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -928,6 +953,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -954,6 +980,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1111,6 +1139,8 @@ class NewPlanTieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice#cadence module Cadence extend Orb::Enum @@ -1128,6 +1158,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice#tiered_config class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -1173,6 +1204,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1199,6 +1231,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1213,6 +1247,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1239,6 +1274,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1397,6 +1434,8 @@ class NewPlanTieredBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice#cadence module Cadence extend Orb::Enum @@ -1414,6 +1453,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice#tiered_bps_config class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -1467,6 +1507,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1493,6 +1534,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1507,6 +1550,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1533,6 +1577,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1689,6 +1735,7 @@ class NewPlanBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice#bps_config class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -1712,6 +1759,8 @@ class BpsConfig < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice#cadence module Cadence extend Orb::Enum @@ -1729,6 +1778,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1755,6 +1805,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1769,6 +1821,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1795,6 +1848,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1951,6 +2006,7 @@ class NewPlanBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -1998,6 +2054,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice#cadence module Cadence extend Orb::Enum @@ -2015,6 +2073,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2041,6 +2100,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2055,6 +2116,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2081,6 +2143,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2237,6 +2301,7 @@ class NewPlanBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice#bulk_config class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -2276,6 +2341,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice#cadence module Cadence extend Orb::Enum @@ -2293,6 +2360,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2319,6 +2387,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2333,6 +2403,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2359,6 +2430,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2517,6 +2590,8 @@ class NewPlanThresholdTotalAmountPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice#cadence module Cadence extend Orb::Enum @@ -2534,6 +2609,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2560,6 +2636,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2574,6 +2652,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2600,6 +2679,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2757,6 +2838,8 @@ class NewPlanTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -2774,6 +2857,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2800,6 +2884,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2814,6 +2900,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2840,6 +2927,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2998,6 +3087,8 @@ class NewPlanTieredWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice#cadence module Cadence extend Orb::Enum @@ -3015,6 +3106,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3041,6 +3133,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3055,6 +3149,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3081,6 +3176,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3238,6 +3335,8 @@ class NewPlanUnitWithPercentPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice#cadence module Cadence extend Orb::Enum @@ -3255,6 +3354,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3281,6 +3381,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3295,6 +3397,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3321,6 +3424,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3479,6 +3584,8 @@ class NewPlanPackageWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice#cadence module Cadence extend Orb::Enum @@ -3496,6 +3603,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3522,6 +3630,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3536,6 +3646,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3562,6 +3673,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3720,6 +3833,8 @@ class NewPlanTierWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -3737,6 +3852,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3763,6 +3879,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3777,6 +3895,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3803,6 +3922,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3961,6 +4082,8 @@ class NewPlanUnitWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -3978,6 +4101,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4004,6 +4128,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4018,6 +4144,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4044,6 +4171,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4202,6 +4331,8 @@ class NewPlanGroupedAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice#cadence module Cadence extend Orb::Enum @@ -4219,6 +4350,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4245,6 +4377,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4259,6 +4393,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4285,6 +4420,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4443,6 +4580,8 @@ class NewPlanGroupedWithProratedMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice#cadence module Cadence extend Orb::Enum @@ -4460,6 +4599,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4486,6 +4626,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4500,6 +4642,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4526,6 +4669,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4684,6 +4829,8 @@ class NewPlanGroupedWithMeteredMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice#cadence module Cadence extend Orb::Enum @@ -4701,6 +4848,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4727,6 +4875,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4741,6 +4891,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4767,6 +4918,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4925,6 +5078,8 @@ class NewPlanMatrixWithDisplayNamePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice#cadence module Cadence extend Orb::Enum @@ -4942,6 +5097,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4968,6 +5124,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4982,6 +5140,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5008,6 +5167,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5166,6 +5327,8 @@ class NewPlanBulkWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -5183,6 +5346,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5209,6 +5373,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5223,6 +5389,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5249,6 +5416,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5407,6 +5576,8 @@ class NewPlanGroupedTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -5424,6 +5595,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5450,6 +5622,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5464,6 +5638,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5490,6 +5665,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5648,6 +5825,8 @@ class NewPlanMaxGroupTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -5665,6 +5844,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5691,6 +5871,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5705,6 +5887,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5731,6 +5914,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5889,6 +6074,8 @@ class NewPlanScalableMatrixWithUnitPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice#cadence module Cadence extend Orb::Enum @@ -5906,6 +6093,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5932,6 +6120,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5946,6 +6136,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5972,6 +6163,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6130,6 +6323,8 @@ class NewPlanScalableMatrixWithTieredPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice#cadence module Cadence extend Orb::Enum @@ -6147,6 +6342,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6173,6 +6369,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6187,6 +6385,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6213,6 +6412,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6371,6 +6572,8 @@ class NewPlanCumulativeGroupedBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice#cadence module Cadence extend Orb::Enum @@ -6388,6 +6591,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6414,6 +6618,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6428,6 +6634,7 @@ module DurationUnit end end + # @see Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6454,6 +6661,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum diff --git a/lib/orb/models/plan_fetch_params.rb b/lib/orb/models/plan_fetch_params.rb index d465bd31..80cb689e 100644 --- a/lib/orb/models/plan_fetch_params.rb +++ b/lib/orb/models/plan_fetch_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Plans#fetch class PlanFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/plan_list_params.rb b/lib/orb/models/plan_list_params.rb index a555a057..5df01bf3 100644 --- a/lib/orb/models/plan_list_params.rb +++ b/lib/orb/models/plan_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Plans#list class PlanListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/plan_update_params.rb b/lib/orb/models/plan_update_params.rb index 870c7ac2..69f3cfe0 100644 --- a/lib/orb/models/plan_update_params.rb +++ b/lib/orb/models/plan_update_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Plans#update class PlanUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/plans/external_plan_id_fetch_params.rb b/lib/orb/models/plans/external_plan_id_fetch_params.rb index 2f50d660..3ac7ed32 100644 --- a/lib/orb/models/plans/external_plan_id_fetch_params.rb +++ b/lib/orb/models/plans/external_plan_id_fetch_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Plans + # @see Orb::Resources::Plans::ExternalPlanID#fetch class ExternalPlanIDFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 5696505a..be580cb2 100644 --- a/lib/orb/models/plans/external_plan_id_update_params.rb +++ b/lib/orb/models/plans/external_plan_id_update_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Plans + # @see Orb::Resources::Plans::ExternalPlanID#update class ExternalPlanIDUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/price.rb b/lib/orb/models/price.rb index 9deed2e6..865f84da 100644 --- a/lib/orb/models/price.rb +++ b/lib/orb/models/price.rb @@ -261,6 +261,7 @@ class UnitPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::UnitPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -275,6 +276,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -295,6 +297,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::UnitPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -309,6 +312,7 @@ module DurationUnit end end + # @see Orb::Models::Price::UnitPrice#cadence module Cadence extend Orb::Enum @@ -326,6 +330,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::UnitPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -346,6 +351,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -366,6 +372,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -380,6 +387,7 @@ module DurationUnit end end + # @see Orb::Models::Price::UnitPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -400,6 +408,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -423,6 +432,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -446,6 +456,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitPrice#price_type module PriceType extend Orb::Enum @@ -459,6 +470,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::UnitPrice#unit_config class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -474,6 +486,7 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -682,6 +695,7 @@ class PackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::PackagePrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -696,6 +710,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -716,6 +731,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::PackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -730,6 +746,7 @@ module DurationUnit end end + # @see Orb::Models::Price::PackagePrice#cadence module Cadence extend Orb::Enum @@ -747,6 +764,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::PackagePrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -767,6 +785,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -787,6 +806,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -801,6 +821,7 @@ module DurationUnit end end + # @see Orb::Models::Price::PackagePrice#item class Item < Orb::BaseModel # @!attribute id # @@ -821,6 +842,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackagePrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -844,6 +866,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackagePrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -867,6 +890,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackagePrice#package_config class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -890,6 +914,7 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackagePrice#price_type module PriceType extend Orb::Enum @@ -903,6 +928,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::PackagePrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -1111,6 +1137,7 @@ class MatrixPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MatrixPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -1125,6 +1152,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -1145,6 +1173,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MatrixPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1159,6 +1188,7 @@ module DurationUnit end end + # @see Orb::Models::Price::MatrixPrice#cadence module Cadence extend Orb::Enum @@ -1176,6 +1206,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::MatrixPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -1196,6 +1227,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -1216,6 +1248,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1230,6 +1263,7 @@ module DurationUnit end end + # @see Orb::Models::Price::MatrixPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -1250,6 +1284,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixPrice#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -1303,6 +1338,7 @@ class MatrixValue < Orb::BaseModel end end + # @see Orb::Models::Price::MatrixPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -1326,6 +1362,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -1349,6 +1386,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixPrice#price_type module PriceType extend Orb::Enum @@ -1362,6 +1400,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::MatrixPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -1570,6 +1609,7 @@ class TieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -1584,6 +1624,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -1604,6 +1645,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1618,6 +1660,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredPrice#cadence module Cadence extend Orb::Enum @@ -1635,6 +1678,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::TieredPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -1655,6 +1699,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -1675,6 +1720,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1689,6 +1735,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -1709,6 +1756,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -1732,6 +1780,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -1755,6 +1804,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPrice#price_type module PriceType extend Orb::Enum @@ -1768,6 +1818,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::TieredPrice#tiered_config class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -1812,6 +1863,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::Price::TieredPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -2021,6 +2073,7 @@ class TieredBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredBpsPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -2035,6 +2088,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -2055,6 +2109,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2069,6 +2124,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredBpsPrice#cadence module Cadence extend Orb::Enum @@ -2086,6 +2142,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::TieredBpsPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -2106,6 +2163,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -2126,6 +2184,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2140,6 +2199,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredBpsPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -2160,6 +2220,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredBpsPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -2183,6 +2244,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredBpsPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -2206,6 +2268,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredBpsPrice#price_type module PriceType extend Orb::Enum @@ -2219,6 +2282,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::TieredBpsPrice#tiered_bps_config class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -2271,6 +2335,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::Price::TieredBpsPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -2479,6 +2544,7 @@ class BpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BpsPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -2493,6 +2559,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -2513,6 +2580,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2527,6 +2595,7 @@ module DurationUnit end end + # @see Orb::Models::Price::BpsPrice#bps_config class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -2549,6 +2618,7 @@ class BpsConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BpsPrice#cadence module Cadence extend Orb::Enum @@ -2566,6 +2636,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::BpsPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -2586,6 +2657,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -2606,6 +2678,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2620,6 +2693,7 @@ module DurationUnit end end + # @see Orb::Models::Price::BpsPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -2640,6 +2714,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BpsPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -2663,6 +2738,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BpsPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -2686,6 +2762,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BpsPrice#price_type module PriceType extend Orb::Enum @@ -2699,6 +2776,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::BpsPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -2907,6 +2985,7 @@ class BulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BulkBpsPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -2921,6 +3000,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -2941,6 +3021,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2955,6 +3036,7 @@ module DurationUnit end end + # @see Orb::Models::Price::BulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -3000,6 +3082,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::Price::BulkBpsPrice#cadence module Cadence extend Orb::Enum @@ -3017,6 +3100,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::BulkBpsPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -3037,6 +3121,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -3057,6 +3142,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3071,6 +3157,7 @@ module DurationUnit end end + # @see Orb::Models::Price::BulkBpsPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -3091,6 +3178,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkBpsPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -3114,6 +3202,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkBpsPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -3137,6 +3226,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkBpsPrice#price_type module PriceType extend Orb::Enum @@ -3150,6 +3240,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::BulkBpsPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -3358,6 +3449,7 @@ class BulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BulkPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -3372,6 +3464,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -3392,6 +3485,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3406,6 +3500,7 @@ module DurationUnit end end + # @see Orb::Models::Price::BulkPrice#bulk_config class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -3443,6 +3538,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::Price::BulkPrice#cadence module Cadence extend Orb::Enum @@ -3460,6 +3556,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::BulkPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -3480,6 +3577,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -3500,6 +3598,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3514,6 +3613,7 @@ module DurationUnit end end + # @see Orb::Models::Price::BulkPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -3534,6 +3634,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -3557,6 +3658,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -3580,6 +3682,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkPrice#price_type module PriceType extend Orb::Enum @@ -3593,6 +3696,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::BulkPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -3806,6 +3910,7 @@ class ThresholdTotalAmountPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::ThresholdTotalAmountPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -3820,6 +3925,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ThresholdTotalAmountPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -3840,6 +3946,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3854,6 +3961,7 @@ module DurationUnit end end + # @see Orb::Models::Price::ThresholdTotalAmountPrice#cadence module Cadence extend Orb::Enum @@ -3871,6 +3979,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::ThresholdTotalAmountPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -3891,6 +4000,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ThresholdTotalAmountPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -3911,6 +4021,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3925,6 +4036,7 @@ module DurationUnit end end + # @see Orb::Models::Price::ThresholdTotalAmountPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -3945,6 +4057,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ThresholdTotalAmountPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -3968,6 +4081,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ThresholdTotalAmountPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -3991,6 +4105,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ThresholdTotalAmountPrice#price_type module PriceType extend Orb::Enum @@ -4004,6 +4119,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::ThresholdTotalAmountPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -4213,6 +4329,7 @@ class TieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredPackagePrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -4227,6 +4344,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -4247,6 +4365,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4261,6 +4380,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -4278,6 +4398,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::TieredPackagePrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -4298,6 +4419,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -4318,6 +4440,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4332,6 +4455,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredPackagePrice#item class Item < Orb::BaseModel # @!attribute id # @@ -4352,6 +4476,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackagePrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -4375,6 +4500,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackagePrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -4398,6 +4524,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackagePrice#price_type module PriceType extend Orb::Enum @@ -4411,6 +4538,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::TieredPackagePrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -4620,6 +4748,7 @@ class GroupedTieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedTieredPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -4634,6 +4763,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -4654,6 +4784,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4668,6 +4799,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedTieredPrice#cadence module Cadence extend Orb::Enum @@ -4685,6 +4817,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::GroupedTieredPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -4705,6 +4838,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -4725,6 +4859,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4739,6 +4874,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedTieredPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -4759,6 +4895,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -4782,6 +4919,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -4805,6 +4943,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPrice#price_type module PriceType extend Orb::Enum @@ -4818,6 +4957,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::GroupedTieredPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -5029,6 +5169,7 @@ class TieredWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredWithMinimumPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -5043,6 +5184,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5063,6 +5205,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5077,6 +5220,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredWithMinimumPrice#cadence module Cadence extend Orb::Enum @@ -5094,6 +5238,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::TieredWithMinimumPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -5114,6 +5259,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5134,6 +5280,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5148,6 +5295,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredWithMinimumPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -5168,6 +5316,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithMinimumPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -5191,6 +5340,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithMinimumPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -5214,6 +5364,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithMinimumPrice#price_type module PriceType extend Orb::Enum @@ -5227,6 +5378,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::TieredWithMinimumPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -5440,6 +5592,7 @@ class TieredPackageWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -5454,6 +5607,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5474,6 +5628,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5488,6 +5643,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#cadence module Cadence extend Orb::Enum @@ -5505,6 +5661,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -5525,6 +5682,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5545,6 +5703,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5559,6 +5718,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -5579,6 +5739,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -5602,6 +5763,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -5625,6 +5787,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#price_type module PriceType extend Orb::Enum @@ -5638,6 +5801,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::TieredPackageWithMinimumPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -5851,6 +6015,7 @@ class PackageWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::PackageWithAllocationPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -5865,6 +6030,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackageWithAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5885,6 +6051,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5899,6 +6066,7 @@ module DurationUnit end end + # @see Orb::Models::Price::PackageWithAllocationPrice#cadence module Cadence extend Orb::Enum @@ -5916,6 +6084,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::PackageWithAllocationPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -5936,6 +6105,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackageWithAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -5956,6 +6126,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5970,6 +6141,7 @@ module DurationUnit end end + # @see Orb::Models::Price::PackageWithAllocationPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -5990,6 +6162,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackageWithAllocationPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -6013,6 +6186,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackageWithAllocationPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -6036,6 +6210,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::PackageWithAllocationPrice#price_type module PriceType extend Orb::Enum @@ -6049,6 +6224,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::PackageWithAllocationPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -6258,6 +6434,7 @@ class UnitWithPercentPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::UnitWithPercentPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -6272,6 +6449,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithPercentPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -6292,6 +6470,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6306,6 +6485,7 @@ module DurationUnit end end + # @see Orb::Models::Price::UnitWithPercentPrice#cadence module Cadence extend Orb::Enum @@ -6323,6 +6503,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::UnitWithPercentPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -6343,6 +6524,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithPercentPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -6363,6 +6545,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6377,6 +6560,7 @@ module DurationUnit end end + # @see Orb::Models::Price::UnitWithPercentPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -6397,6 +6581,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithPercentPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -6420,6 +6605,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithPercentPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -6443,6 +6629,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithPercentPrice#price_type module PriceType extend Orb::Enum @@ -6456,6 +6643,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::UnitWithPercentPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -6670,6 +6858,7 @@ class MatrixWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MatrixWithAllocationPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -6684,6 +6873,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -6704,6 +6894,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6718,6 +6909,7 @@ module DurationUnit end end + # @see Orb::Models::Price::MatrixWithAllocationPrice#cadence module Cadence extend Orb::Enum @@ -6735,6 +6927,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::MatrixWithAllocationPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -6755,6 +6948,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -6775,6 +6969,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6789,6 +6984,7 @@ module DurationUnit end end + # @see Orb::Models::Price::MatrixWithAllocationPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -6809,6 +7005,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithAllocationPrice#matrix_with_allocation_config class MatrixWithAllocationConfig < Orb::BaseModel # @!attribute allocation # Allocation to be used to calculate the price @@ -6870,6 +7067,7 @@ class MatrixValue < Orb::BaseModel end end + # @see Orb::Models::Price::MatrixWithAllocationPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -6893,6 +7091,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithAllocationPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -6916,6 +7115,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithAllocationPrice#price_type module PriceType extend Orb::Enum @@ -6929,6 +7129,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::MatrixWithAllocationPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -7140,6 +7341,7 @@ class TieredWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredWithProrationPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -7154,6 +7356,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -7174,6 +7377,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7188,6 +7392,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -7205,6 +7410,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::TieredWithProrationPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -7225,6 +7431,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -7245,6 +7452,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7259,6 +7467,7 @@ module DurationUnit end end + # @see Orb::Models::Price::TieredWithProrationPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -7279,6 +7488,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithProrationPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -7302,6 +7512,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithProrationPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -7325,6 +7536,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::TieredWithProrationPrice#price_type module PriceType extend Orb::Enum @@ -7338,6 +7550,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::TieredWithProrationPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -7549,6 +7762,7 @@ class UnitWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::UnitWithProrationPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -7563,6 +7777,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -7583,6 +7798,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7597,6 +7813,7 @@ module DurationUnit end end + # @see Orb::Models::Price::UnitWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -7614,6 +7831,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::UnitWithProrationPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -7634,6 +7852,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -7654,6 +7873,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7668,6 +7888,7 @@ module DurationUnit end end + # @see Orb::Models::Price::UnitWithProrationPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -7688,6 +7909,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithProrationPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -7711,6 +7933,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithProrationPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -7734,6 +7957,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::UnitWithProrationPrice#price_type module PriceType extend Orb::Enum @@ -7747,6 +7971,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::UnitWithProrationPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -7958,6 +8183,7 @@ class GroupedAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedAllocationPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -7972,6 +8198,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -7992,6 +8219,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8006,6 +8234,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedAllocationPrice#cadence module Cadence extend Orb::Enum @@ -8023,6 +8252,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::GroupedAllocationPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -8043,6 +8273,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -8063,6 +8294,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8077,6 +8309,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedAllocationPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -8097,6 +8330,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedAllocationPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -8120,6 +8354,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedAllocationPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -8143,6 +8378,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedAllocationPrice#price_type module PriceType extend Orb::Enum @@ -8156,6 +8392,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::GroupedAllocationPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -8369,6 +8606,7 @@ class GroupedWithProratedMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -8383,6 +8621,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -8403,6 +8642,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8417,6 +8657,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#cadence module Cadence extend Orb::Enum @@ -8434,6 +8675,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -8454,6 +8696,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -8474,6 +8717,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8488,6 +8732,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -8508,6 +8753,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -8531,6 +8777,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -8554,6 +8801,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#price_type module PriceType extend Orb::Enum @@ -8567,6 +8815,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::GroupedWithProratedMinimumPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -8780,6 +9029,7 @@ class GroupedWithMeteredMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -8794,6 +9044,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -8814,6 +9065,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8828,6 +9080,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#cadence module Cadence extend Orb::Enum @@ -8845,6 +9098,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -8865,6 +9119,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -8885,6 +9140,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8899,6 +9155,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -8919,6 +9176,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -8942,6 +9200,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -8965,6 +9224,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#price_type module PriceType extend Orb::Enum @@ -8978,6 +9238,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::GroupedWithMeteredMinimumPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -9191,6 +9452,7 @@ class MatrixWithDisplayNamePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -9205,6 +9467,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -9225,6 +9488,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9239,6 +9503,7 @@ module DurationUnit end end + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#cadence module Cadence extend Orb::Enum @@ -9256,6 +9521,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -9276,6 +9542,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -9296,6 +9563,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9310,6 +9578,7 @@ module DurationUnit end end + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#item class Item < Orb::BaseModel # @!attribute id # @@ -9330,6 +9599,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -9353,6 +9623,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -9376,6 +9647,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#price_type module PriceType extend Orb::Enum @@ -9389,6 +9661,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::MatrixWithDisplayNamePrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -9600,6 +9873,7 @@ class BulkWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BulkWithProrationPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -9614,6 +9888,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -9634,6 +9909,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9648,6 +9924,7 @@ module DurationUnit end end + # @see Orb::Models::Price::BulkWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -9665,6 +9942,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::BulkWithProrationPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -9685,6 +9963,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -9705,6 +9984,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9719,6 +9999,7 @@ module DurationUnit end end + # @see Orb::Models::Price::BulkWithProrationPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -9739,6 +10020,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkWithProrationPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -9762,6 +10044,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkWithProrationPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -9785,6 +10068,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::BulkWithProrationPrice#price_type module PriceType extend Orb::Enum @@ -9798,6 +10082,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::BulkWithProrationPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -10011,6 +10296,7 @@ class GroupedTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedTieredPackagePrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -10025,6 +10311,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -10045,6 +10332,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10059,6 +10347,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -10076,6 +10365,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::GroupedTieredPackagePrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -10096,6 +10386,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -10116,6 +10407,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10130,6 +10422,7 @@ module DurationUnit end end + # @see Orb::Models::Price::GroupedTieredPackagePrice#item class Item < Orb::BaseModel # @!attribute id # @@ -10150,6 +10443,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPackagePrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -10173,6 +10467,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPackagePrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -10196,6 +10491,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::GroupedTieredPackagePrice#price_type module PriceType extend Orb::Enum @@ -10209,6 +10505,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::GroupedTieredPackagePrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -10422,6 +10719,7 @@ class MaxGroupTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -10436,6 +10734,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -10456,6 +10755,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10470,6 +10770,7 @@ module DurationUnit end end + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -10487,6 +10788,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -10507,6 +10809,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -10527,6 +10830,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10541,6 +10845,7 @@ module DurationUnit end end + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#item class Item < Orb::BaseModel # @!attribute id # @@ -10561,6 +10866,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -10584,6 +10890,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -10607,6 +10914,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#price_type module PriceType extend Orb::Enum @@ -10620,6 +10928,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::MaxGroupTieredPackagePrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -10833,6 +11142,7 @@ class ScalableMatrixWithUnitPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -10847,6 +11157,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -10867,6 +11178,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10881,6 +11193,7 @@ module DurationUnit end end + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#cadence module Cadence extend Orb::Enum @@ -10898,6 +11211,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -10918,6 +11232,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -10938,6 +11253,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10952,6 +11268,7 @@ module DurationUnit end end + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -10972,6 +11289,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -10995,6 +11313,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -11018,6 +11337,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#price_type module PriceType extend Orb::Enum @@ -11031,6 +11351,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::ScalableMatrixWithUnitPricingPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -11244,6 +11565,7 @@ class ScalableMatrixWithTieredPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -11258,6 +11580,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -11278,6 +11601,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11292,6 +11616,7 @@ module DurationUnit end end + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#cadence module Cadence extend Orb::Enum @@ -11309,6 +11634,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -11329,6 +11655,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -11349,6 +11676,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11363,6 +11691,7 @@ module DurationUnit end end + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -11383,6 +11712,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -11406,6 +11736,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -11429,6 +11760,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#price_type module PriceType extend Orb::Enum @@ -11442,6 +11774,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::ScalableMatrixWithTieredPricingPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # @@ -11655,6 +11988,7 @@ class CumulativeGroupedBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -11669,6 +12003,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -11689,6 +12024,7 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11703,6 +12039,7 @@ module DurationUnit end end + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#cadence module Cadence extend Orb::Enum @@ -11720,6 +12057,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#credit_allocation class CreditAllocation < Orb::BaseModel # @!attribute allows_rollover # @@ -11740,6 +12078,7 @@ class CreditAllocation < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # @@ -11760,6 +12099,7 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11774,6 +12114,7 @@ module DurationUnit end end + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#item class Item < Orb::BaseModel # @!attribute id # @@ -11794,6 +12135,7 @@ class Item < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#maximum class Maximum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this maximum amount applies to. For plan/plan phase @@ -11817,6 +12159,7 @@ class Maximum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#minimum class Minimum < Orb::BaseModel # @!attribute applies_to_price_ids # List of price_ids that this minimum amount applies to. For plan/plan phase @@ -11840,6 +12183,7 @@ class Minimum < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#price_type module PriceType extend Orb::Enum @@ -11853,6 +12197,7 @@ module PriceType # def self.values; end end + # @see Orb::Models::Price::CumulativeGroupedBulkPrice#dimensional_price_configuration class DimensionalPriceConfiguration < Orb::BaseModel # @!attribute dimension_values # diff --git a/lib/orb/models/price_create_params.rb b/lib/orb/models/price_create_params.rb index e1ae61d5..dded42ca 100644 --- a/lib/orb/models/price_create_params.rb +++ b/lib/orb/models/price_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Prices#create class PriceCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -408,6 +409,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PriceCreateParams::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -448,6 +451,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::PriceCreateParams::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum diff --git a/lib/orb/models/price_evaluate_params.rb b/lib/orb/models/price_evaluate_params.rb index 0bfca384..d6a48a1e 100644 --- a/lib/orb/models/price_evaluate_params.rb +++ b/lib/orb/models/price_evaluate_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Prices#evaluate class PriceEvaluateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/price_fetch_params.rb b/lib/orb/models/price_fetch_params.rb index a49130a5..f1b95ee0 100644 --- a/lib/orb/models/price_fetch_params.rb +++ b/lib/orb/models/price_fetch_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Prices#fetch class PriceFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/price_list_params.rb b/lib/orb/models/price_list_params.rb index 6df62169..94727225 100644 --- a/lib/orb/models/price_list_params.rb +++ b/lib/orb/models/price_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Prices#list class PriceListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/price_update_params.rb b/lib/orb/models/price_update_params.rb index ab59651c..17129f88 100644 --- a/lib/orb/models/price_update_params.rb +++ b/lib/orb/models/price_update_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Prices#update class PriceUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/prices/external_price_id_fetch_params.rb b/lib/orb/models/prices/external_price_id_fetch_params.rb index 78435664..536ea819 100644 --- a/lib/orb/models/prices/external_price_id_fetch_params.rb +++ b/lib/orb/models/prices/external_price_id_fetch_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Prices + # @see Orb::Resources::Prices::ExternalPriceID#fetch class ExternalPriceIDFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 14c0c5a6..8a0001d4 100644 --- a/lib/orb/models/prices/external_price_id_update_params.rb +++ b/lib/orb/models/prices/external_price_id_update_params.rb @@ -3,6 +3,7 @@ module Orb module Models module Prices + # @see Orb::Resources::Prices::ExternalPriceID#update class ExternalPriceIDUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription.rb b/lib/orb/models/subscription.rb index 38c5de7f..a515305b 100644 --- a/lib/orb/models/subscription.rb +++ b/lib/orb/models/subscription.rb @@ -305,6 +305,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::Subscription::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -679,6 +680,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::Subscription#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1169,6 +1171,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::Subscription#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1195,6 +1198,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::Subscription#status module Status extend Orb::Enum @@ -1209,6 +1213,7 @@ module Status # def self.values; end end + # @see Orb::Models::Subscription#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_cancel_params.rb b/lib/orb/models/subscription_cancel_params.rb index 9793f7d5..c8166b5a 100644 --- a/lib/orb/models/subscription_cancel_params.rb +++ b/lib/orb/models/subscription_cancel_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#cancel class SubscriptionCancelParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_cancel_response.rb b/lib/orb/models/subscription_cancel_response.rb index 52a1f9db..56913070 100644 --- a/lib/orb/models/subscription_cancel_response.rb +++ b/lib/orb/models/subscription_cancel_response.rb @@ -288,6 +288,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCancelResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -662,6 +663,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCancelResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1153,6 +1155,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCancelResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1179,6 +1182,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionCancelResponse#status module Status extend Orb::Enum @@ -1193,6 +1197,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionCancelResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_create_params.rb b/lib/orb/models/subscription_create_params.rb index 104b9727..90554937 100644 --- a/lib/orb/models/subscription_create_params.rb +++ b/lib/orb/models/subscription_create_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#create class SubscriptionCreateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -344,6 +345,8 @@ class AddAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The definition of a new adjustment to create and add to the subscription. + # + # @see Orb::Models::SubscriptionCreateParams::AddAdjustment#adjustment module Adjustment extend Orb::Union @@ -680,6 +683,7 @@ class AddPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::AddPrice#allocation_price class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -720,6 +724,8 @@ class AllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence at which to allocate the amount to the customer. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice#cadence module Cadence extend Orb::Enum @@ -775,6 +781,7 @@ class Discount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Discount#discount_type module DiscountType extend Orb::Enum @@ -791,6 +798,8 @@ module DiscountType end # The definition of a new price to create and add to the subscription. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice#price module Price extend Orb::Union @@ -1019,6 +1028,8 @@ class NewSubscriptionUnitPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice#cadence module Cadence extend Orb::Enum @@ -1036,6 +1047,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice#unit_config class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -1051,6 +1063,7 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1077,6 +1090,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1091,6 +1106,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1117,6 +1133,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1285,6 +1303,8 @@ class NewSubscriptionPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice#cadence module Cadence extend Orb::Enum @@ -1302,6 +1322,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice#package_config class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -1325,6 +1346,7 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1351,6 +1373,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1365,6 +1389,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1391,6 +1416,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1559,6 +1586,8 @@ class NewSubscriptionMatrixPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice#cadence module Cadence extend Orb::Enum @@ -1576,6 +1605,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -1634,6 +1664,7 @@ class MatrixValue < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1660,6 +1691,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1674,6 +1707,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1700,6 +1734,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1868,6 +1904,8 @@ class NewSubscriptionTieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice#cadence module Cadence extend Orb::Enum @@ -1885,6 +1923,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice#tiered_config class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -1930,6 +1969,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1956,6 +1996,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1970,6 +2012,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1996,6 +2039,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2164,6 +2209,8 @@ class NewSubscriptionTieredBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#cadence module Cadence extend Orb::Enum @@ -2181,6 +2228,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#tiered_bps_config class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -2238,6 +2286,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2264,6 +2313,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2278,6 +2329,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2304,6 +2356,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2471,6 +2525,7 @@ class NewSubscriptionBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice#bps_config class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -2494,6 +2549,8 @@ class BpsConfig < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice#cadence module Cadence extend Orb::Enum @@ -2511,6 +2568,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2537,6 +2595,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2551,6 +2611,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2577,6 +2638,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2744,6 +2807,7 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -2791,6 +2855,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#cadence module Cadence extend Orb::Enum @@ -2808,6 +2874,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2834,6 +2901,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2848,6 +2917,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2874,6 +2944,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3041,6 +3113,7 @@ class NewSubscriptionBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice#bulk_config class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -3080,6 +3153,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice#cadence module Cadence extend Orb::Enum @@ -3097,6 +3172,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3123,6 +3199,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3137,6 +3215,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3163,6 +3242,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3330,6 +3411,8 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice#cadence module Cadence extend Orb::Enum @@ -3347,6 +3430,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3373,6 +3457,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3387,6 +3473,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3413,6 +3500,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3580,6 +3669,8 @@ class NewSubscriptionTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -3597,6 +3688,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3623,6 +3715,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3637,6 +3731,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3663,6 +3758,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3830,6 +3927,8 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice#cadence module Cadence extend Orb::Enum @@ -3847,6 +3946,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3873,6 +3973,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3887,6 +3989,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3913,6 +4016,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4080,6 +4185,8 @@ class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice#cadence module Cadence extend Orb::Enum @@ -4097,6 +4204,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4123,6 +4231,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4137,6 +4247,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4163,6 +4274,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4330,6 +4443,8 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice#cadence module Cadence extend Orb::Enum @@ -4347,6 +4462,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4373,6 +4489,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4387,6 +4505,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4413,6 +4532,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4580,6 +4701,8 @@ class NewSubscriptionTierWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -4597,6 +4720,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4623,6 +4747,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4637,6 +4763,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4663,6 +4790,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4830,6 +4959,8 @@ class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -4847,6 +4978,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4873,6 +5005,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4887,6 +5021,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4913,6 +5048,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5080,6 +5217,8 @@ class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#cadence module Cadence extend Orb::Enum @@ -5097,6 +5236,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5123,6 +5263,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5137,6 +5279,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5163,6 +5306,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5330,6 +5475,8 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#cadence module Cadence extend Orb::Enum @@ -5347,6 +5494,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5373,6 +5521,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5387,6 +5537,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5413,6 +5564,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5580,6 +5733,8 @@ class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -5597,6 +5752,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5623,6 +5779,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5637,6 +5795,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5663,6 +5822,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5830,6 +5991,8 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#cadence module Cadence extend Orb::Enum @@ -5847,6 +6010,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5873,6 +6037,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5887,6 +6053,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5913,6 +6080,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6080,6 +6249,8 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#cadence module Cadence extend Orb::Enum @@ -6097,6 +6268,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6123,6 +6295,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6137,6 +6311,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6163,6 +6338,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6330,6 +6507,8 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#cadence module Cadence extend Orb::Enum @@ -6347,6 +6526,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6373,6 +6553,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6387,6 +6569,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6413,6 +6596,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6580,6 +6765,8 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -6597,6 +6784,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6623,6 +6811,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6637,6 +6827,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6663,6 +6854,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6830,6 +7023,8 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#cadence module Cadence extend Orb::Enum @@ -6847,6 +7042,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6873,6 +7069,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6887,6 +7085,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6913,6 +7112,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7080,6 +7281,8 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#cadence module Cadence extend Orb::Enum @@ -7097,6 +7300,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7123,6 +7327,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7137,6 +7343,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7163,6 +7370,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7330,6 +7539,8 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -7347,6 +7558,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7373,6 +7585,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7387,6 +7601,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7413,6 +7628,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7543,6 +7760,8 @@ class ReplaceAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The definition of a new adjustment to create and add to the subscription. + # + # @see Orb::Models::SubscriptionCreateParams::ReplaceAdjustment#adjustment module Adjustment extend Orb::Union @@ -7867,6 +8086,7 @@ class ReplacePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice#allocation_price class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -7908,6 +8128,8 @@ class AllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence at which to allocate the amount to the customer. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice#cadence module Cadence extend Orb::Enum @@ -7963,6 +8185,7 @@ class Discount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount#discount_type module DiscountType extend Orb::Enum @@ -7979,6 +8202,8 @@ module DiscountType end # The definition of a new price to create and add to the subscription. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice#price module Price extend Orb::Union @@ -8209,6 +8434,8 @@ class NewSubscriptionUnitPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice#cadence module Cadence extend Orb::Enum @@ -8226,6 +8453,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice#unit_config class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -8241,6 +8469,7 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8267,6 +8496,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8281,6 +8512,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8307,6 +8539,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8475,6 +8709,8 @@ class NewSubscriptionPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice#cadence module Cadence extend Orb::Enum @@ -8492,6 +8728,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice#package_config class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -8515,6 +8752,7 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8541,6 +8779,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8555,6 +8795,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8581,6 +8822,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8749,6 +8992,8 @@ class NewSubscriptionMatrixPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#cadence module Cadence extend Orb::Enum @@ -8766,6 +9011,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -8824,6 +9070,7 @@ class MatrixValue < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8850,6 +9097,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8864,6 +9113,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8890,6 +9140,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9058,6 +9310,8 @@ class NewSubscriptionTieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice#cadence module Cadence extend Orb::Enum @@ -9075,6 +9329,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice#tiered_config class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -9120,6 +9375,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9146,6 +9402,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9160,6 +9418,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9186,6 +9445,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9354,6 +9615,8 @@ class NewSubscriptionTieredBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#cadence module Cadence extend Orb::Enum @@ -9371,6 +9634,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#tiered_bps_config class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -9428,6 +9692,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9454,6 +9719,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9468,6 +9735,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9494,6 +9762,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9661,6 +9931,7 @@ class NewSubscriptionBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice#bps_config class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -9684,6 +9955,8 @@ class BpsConfig < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice#cadence module Cadence extend Orb::Enum @@ -9701,6 +9974,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9727,6 +10001,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9741,6 +10017,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9767,6 +10044,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9934,6 +10213,7 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -9985,6 +10265,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#cadence module Cadence extend Orb::Enum @@ -10002,6 +10284,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10028,6 +10311,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10042,6 +10327,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10068,6 +10354,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10235,6 +10523,7 @@ class NewSubscriptionBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice#bulk_config class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -10274,6 +10563,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice#cadence module Cadence extend Orb::Enum @@ -10291,6 +10582,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10317,6 +10609,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10331,6 +10625,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10357,6 +10652,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10524,6 +10821,8 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice#cadence module Cadence extend Orb::Enum @@ -10541,6 +10840,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10567,6 +10867,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10581,6 +10883,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10607,6 +10910,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10774,6 +11079,8 @@ class NewSubscriptionTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -10791,6 +11098,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10817,6 +11125,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10831,6 +11141,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10857,6 +11168,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11024,6 +11337,8 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice#cadence module Cadence extend Orb::Enum @@ -11041,6 +11356,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11067,6 +11383,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11081,6 +11399,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11107,6 +11426,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11274,6 +11595,8 @@ class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice#cadence module Cadence extend Orb::Enum @@ -11291,6 +11614,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11317,6 +11641,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11331,6 +11657,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11357,6 +11684,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11524,6 +11853,8 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice#cadence module Cadence extend Orb::Enum @@ -11541,6 +11872,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11567,6 +11899,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11581,6 +11915,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11607,6 +11942,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11774,6 +12111,8 @@ class NewSubscriptionTierWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -11791,6 +12130,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11817,6 +12157,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11831,6 +12173,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11857,6 +12200,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12024,6 +12369,8 @@ class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -12041,6 +12388,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12067,6 +12415,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12081,6 +12431,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12107,6 +12458,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12274,6 +12627,8 @@ class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice#cadence module Cadence extend Orb::Enum @@ -12291,6 +12646,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12317,6 +12673,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12331,6 +12689,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12357,6 +12716,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12524,6 +12885,8 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#cadence module Cadence extend Orb::Enum @@ -12541,6 +12904,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12567,6 +12931,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12581,6 +12947,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12607,6 +12974,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12774,6 +13143,8 @@ class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -12791,6 +13162,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12817,6 +13189,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12831,6 +13205,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12857,6 +13232,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13024,6 +13401,8 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#cadence module Cadence extend Orb::Enum @@ -13041,6 +13420,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13067,6 +13447,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13081,6 +13463,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13107,6 +13490,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13274,6 +13659,8 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#cadence module Cadence extend Orb::Enum @@ -13291,6 +13678,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13317,6 +13705,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13331,6 +13721,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13357,6 +13748,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13524,6 +13917,8 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#cadence module Cadence extend Orb::Enum @@ -13541,6 +13936,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13567,6 +13963,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13581,6 +13979,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13607,6 +14006,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13774,6 +14175,8 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -13791,6 +14194,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13817,6 +14221,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13831,6 +14237,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13857,6 +14264,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14024,6 +14433,8 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#cadence module Cadence extend Orb::Enum @@ -14041,6 +14452,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14067,6 +14479,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14081,6 +14495,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14107,6 +14522,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14274,6 +14691,8 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#cadence module Cadence extend Orb::Enum @@ -14291,6 +14710,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14317,6 +14737,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14331,6 +14753,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14357,6 +14780,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14524,6 +14949,8 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -14541,6 +14968,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14567,6 +14995,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14581,6 +15011,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14607,6 +15038,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum diff --git a/lib/orb/models/subscription_create_response.rb b/lib/orb/models/subscription_create_response.rb index 284b8a74..4a4fb60d 100644 --- a/lib/orb/models/subscription_create_response.rb +++ b/lib/orb/models/subscription_create_response.rb @@ -288,6 +288,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionCreateResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -662,6 +663,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCreateResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1153,6 +1155,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionCreateResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1179,6 +1182,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionCreateResponse#status module Status extend Orb::Enum @@ -1193,6 +1197,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionCreateResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_fetch_costs_params.rb b/lib/orb/models/subscription_fetch_costs_params.rb index 266879aa..f0f38874 100644 --- a/lib/orb/models/subscription_fetch_costs_params.rb +++ b/lib/orb/models/subscription_fetch_costs_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#fetch_costs class SubscriptionFetchCostsParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_fetch_params.rb b/lib/orb/models/subscription_fetch_params.rb index 128b31ef..5fb039e5 100644 --- a/lib/orb/models/subscription_fetch_params.rb +++ b/lib/orb/models/subscription_fetch_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#fetch class SubscriptionFetchParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_fetch_schedule_params.rb b/lib/orb/models/subscription_fetch_schedule_params.rb index a1321112..9f46a42b 100644 --- a/lib/orb/models/subscription_fetch_schedule_params.rb +++ b/lib/orb/models/subscription_fetch_schedule_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#fetch_schedule class SubscriptionFetchScheduleParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_fetch_schedule_response.rb b/lib/orb/models/subscription_fetch_schedule_response.rb index 38ccc9d7..5234e19d 100644 --- a/lib/orb/models/subscription_fetch_schedule_response.rb +++ b/lib/orb/models/subscription_fetch_schedule_response.rb @@ -33,6 +33,7 @@ class SubscriptionFetchScheduleResponse < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionFetchScheduleResponse#plan class Plan < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_fetch_usage_params.rb b/lib/orb/models/subscription_fetch_usage_params.rb index e95eb6d4..e2147b7c 100644 --- a/lib/orb/models/subscription_fetch_usage_params.rb +++ b/lib/orb/models/subscription_fetch_usage_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#fetch_usage class SubscriptionFetchUsageParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_list_params.rb b/lib/orb/models/subscription_list_params.rb index 12986f76..13ab9250 100644 --- a/lib/orb/models/subscription_list_params.rb +++ b/lib/orb/models/subscription_list_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#list class SubscriptionListParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_price_intervals_params.rb b/lib/orb/models/subscription_price_intervals_params.rb index 0e646160..99ca40bc 100644 --- a/lib/orb/models/subscription_price_intervals_params.rb +++ b/lib/orb/models/subscription_price_intervals_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#price_intervals class SubscriptionPriceIntervalsParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -206,6 +207,8 @@ class Add < Orb::BaseModel # The start date of the price interval. This is the date that the price will start # billing on the subscription. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#start_date module StartDate extend Orb::Union @@ -218,6 +221,7 @@ module StartDate # def self.variants; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#allocation_price class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -259,6 +263,8 @@ class AllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence at which to allocate the amount to the customer. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice#cadence module Cadence extend Orb::Enum @@ -363,6 +369,8 @@ class UsageDiscountCreationParams < Orb::BaseModel # The end date of the price interval. This is the date that the price will stop # billing on the subscription. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#end_date module EndDate extend Orb::Union @@ -398,6 +406,8 @@ class FixedFeeQuantityTransition < Orb::BaseModel end # The definition of a new price to create and add to the subscription. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add#price module Price extend Orb::Union @@ -625,6 +635,8 @@ class NewFloatingUnitPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice#cadence module Cadence extend Orb::Enum @@ -642,6 +654,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice#unit_config class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -657,6 +670,7 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -683,6 +697,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -697,6 +713,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -723,6 +740,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -881,6 +900,8 @@ class NewFloatingPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice#cadence module Cadence extend Orb::Enum @@ -898,6 +919,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice#package_config class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -921,6 +943,7 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -947,6 +970,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -961,6 +986,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -987,6 +1013,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1145,6 +1173,8 @@ class NewFloatingMatrixPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice#cadence module Cadence extend Orb::Enum @@ -1162,6 +1192,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -1220,6 +1251,7 @@ class MatrixValue < Orb::BaseModel end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1246,6 +1278,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1260,6 +1294,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1286,6 +1321,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1444,6 +1481,8 @@ class NewFloatingMatrixWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice#cadence module Cadence extend Orb::Enum @@ -1461,6 +1500,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice#matrix_with_allocation_config class MatrixWithAllocationConfig < Orb::BaseModel # @!attribute allocation # Allocation to be used to calculate the price @@ -1526,6 +1566,7 @@ class MatrixValue < Orb::BaseModel end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1552,6 +1593,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1566,6 +1609,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1592,6 +1636,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1750,6 +1796,8 @@ class NewFloatingTieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice#cadence module Cadence extend Orb::Enum @@ -1767,6 +1815,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice#tiered_config class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -1812,6 +1861,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1838,6 +1888,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1852,6 +1904,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1878,6 +1931,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2036,6 +2091,8 @@ class NewFloatingTieredBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice#cadence module Cadence extend Orb::Enum @@ -2053,6 +2110,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice#tiered_bps_config class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -2110,6 +2168,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2136,6 +2195,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2150,6 +2211,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2176,6 +2238,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2333,6 +2397,7 @@ class NewFloatingBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice#bps_config class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -2356,6 +2421,8 @@ class BpsConfig < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice#cadence module Cadence extend Orb::Enum @@ -2373,6 +2440,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2399,6 +2467,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2413,6 +2483,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2439,6 +2510,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2596,6 +2669,7 @@ class NewFloatingBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -2643,6 +2717,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice#cadence module Cadence extend Orb::Enum @@ -2660,6 +2736,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2686,6 +2763,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2700,6 +2779,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2726,6 +2806,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2883,6 +2965,7 @@ class NewFloatingBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice#bulk_config class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -2922,6 +3005,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice#cadence module Cadence extend Orb::Enum @@ -2939,6 +3024,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2965,6 +3051,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2979,6 +3067,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3005,6 +3094,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3162,6 +3253,8 @@ class NewFloatingThresholdTotalAmountPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice#cadence module Cadence extend Orb::Enum @@ -3179,6 +3272,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3205,6 +3299,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3219,6 +3315,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3245,6 +3342,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3402,6 +3501,8 @@ class NewFloatingTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -3419,6 +3520,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3445,6 +3547,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3459,6 +3563,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3485,6 +3590,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3642,6 +3749,8 @@ class NewFloatingGroupedTieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice#cadence module Cadence extend Orb::Enum @@ -3659,6 +3768,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3685,6 +3795,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3699,6 +3811,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3725,6 +3838,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3882,6 +3997,8 @@ class NewFloatingMaxGroupTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -3899,6 +4016,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3925,6 +4043,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3939,6 +4059,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3965,6 +4086,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4122,6 +4245,8 @@ class NewFloatingTieredWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice#cadence module Cadence extend Orb::Enum @@ -4139,6 +4264,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4165,6 +4291,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4179,6 +4307,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4205,6 +4334,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4362,6 +4493,8 @@ class NewFloatingPackageWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice#cadence module Cadence extend Orb::Enum @@ -4379,6 +4512,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4405,6 +4539,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4419,6 +4555,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4445,6 +4582,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4602,6 +4741,8 @@ class NewFloatingTieredPackageWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice#cadence module Cadence extend Orb::Enum @@ -4619,6 +4760,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4645,6 +4787,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4659,6 +4803,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4685,6 +4830,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4842,6 +4989,8 @@ class NewFloatingUnitWithPercentPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice#cadence module Cadence extend Orb::Enum @@ -4859,6 +5008,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4885,6 +5035,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4899,6 +5051,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4925,6 +5078,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5082,6 +5237,8 @@ class NewFloatingTieredWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -5099,6 +5256,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5125,6 +5283,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5139,6 +5299,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5165,6 +5326,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5322,6 +5485,8 @@ class NewFloatingUnitWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -5339,6 +5504,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5365,6 +5531,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5379,6 +5547,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5405,6 +5574,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5562,6 +5733,8 @@ class NewFloatingGroupedAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice#cadence module Cadence extend Orb::Enum @@ -5579,6 +5752,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5605,6 +5779,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5619,6 +5795,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5645,6 +5822,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5802,6 +5981,8 @@ class NewFloatingGroupedWithProratedMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice#cadence module Cadence extend Orb::Enum @@ -5819,6 +6000,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5845,6 +6027,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5859,6 +6043,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5885,6 +6070,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6042,6 +6229,8 @@ class NewFloatingGroupedWithMeteredMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice#cadence module Cadence extend Orb::Enum @@ -6059,6 +6248,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6085,6 +6275,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6099,6 +6291,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6125,6 +6318,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6282,6 +6477,8 @@ class NewFloatingMatrixWithDisplayNamePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice#cadence module Cadence extend Orb::Enum @@ -6299,6 +6496,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6325,6 +6523,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6339,6 +6539,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6365,6 +6566,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6522,6 +6725,8 @@ class NewFloatingBulkWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -6539,6 +6744,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6565,6 +6771,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6579,6 +6787,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6605,6 +6814,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6762,6 +6973,8 @@ class NewFloatingGroupedTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -6779,6 +6992,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6805,6 +7019,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6819,6 +7035,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6845,6 +7062,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7002,6 +7221,8 @@ class NewFloatingScalableMatrixWithUnitPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice#cadence module Cadence extend Orb::Enum @@ -7019,6 +7240,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7045,6 +7267,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7059,6 +7283,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7085,6 +7310,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7242,6 +7469,8 @@ class NewFloatingScalableMatrixWithTieredPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice#cadence module Cadence extend Orb::Enum @@ -7259,6 +7488,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7285,6 +7515,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7299,6 +7531,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7325,6 +7558,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7482,6 +7717,8 @@ class NewFloatingCumulativeGroupedBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice#cadence module Cadence extend Orb::Enum @@ -7499,6 +7736,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7525,6 +7763,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7539,6 +7779,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7565,6 +7806,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7625,6 +7868,8 @@ class AddAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The definition of a new adjustment to create and add to the subscription. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#adjustment module Adjustment extend Orb::Union @@ -7864,6 +8109,8 @@ class NewMaximum < Orb::BaseModel # 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 extend Orb::Union @@ -7880,6 +8127,8 @@ module StartDate # 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 extend Orb::Union @@ -7982,6 +8231,8 @@ class Edit < Orb::BaseModel # The updated end date of this price interval. If not specified, the start date # will not be updated. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#end_date module EndDate extend Orb::Union @@ -8018,6 +8269,8 @@ class FixedFeeQuantityTransition < Orb::BaseModel # The updated start date of this price interval. If not specified, the start date # will not be updated. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#start_date module StartDate extend Orb::Union @@ -8070,6 +8323,8 @@ class EditAdjustment < Orb::BaseModel # The updated end date of this adjustment interval. If not specified, the start # date will not be updated. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#end_date module EndDate extend Orb::Union @@ -8084,6 +8339,8 @@ module EndDate # The updated start date of this adjustment interval. If not specified, the start # date will not be updated. + # + # @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#start_date module StartDate extend Orb::Union diff --git a/lib/orb/models/subscription_price_intervals_response.rb b/lib/orb/models/subscription_price_intervals_response.rb index 3d890b0b..dac70ab6 100644 --- a/lib/orb/models/subscription_price_intervals_response.rb +++ b/lib/orb/models/subscription_price_intervals_response.rb @@ -293,6 +293,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionPriceIntervalsResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -667,6 +668,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionPriceIntervalsResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1160,6 +1162,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionPriceIntervalsResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1186,6 +1189,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionPriceIntervalsResponse#status module Status extend Orb::Enum @@ -1200,6 +1204,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionPriceIntervalsResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_schedule_plan_change_params.rb b/lib/orb/models/subscription_schedule_plan_change_params.rb index c8054e12..75a6c497 100644 --- a/lib/orb/models/subscription_schedule_plan_change_params.rb +++ b/lib/orb/models/subscription_schedule_plan_change_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#schedule_plan_change class SubscriptionSchedulePlanChangeParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter @@ -327,6 +328,8 @@ class AddAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The definition of a new adjustment to create and add to the subscription. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment#adjustment module Adjustment extend Orb::Union @@ -667,6 +670,7 @@ class AddPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice#allocation_price class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -708,6 +712,8 @@ class AllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence at which to allocate the amount to the customer. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice#cadence module Cadence extend Orb::Enum @@ -763,6 +769,7 @@ class Discount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount#discount_type module DiscountType extend Orb::Enum @@ -779,6 +786,8 @@ module DiscountType end # The definition of a new price to create and add to the subscription. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice#price module Price extend Orb::Union @@ -1012,6 +1021,8 @@ class NewSubscriptionUnitPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice#cadence module Cadence extend Orb::Enum @@ -1029,6 +1040,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice#unit_config class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -1044,6 +1056,7 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1070,6 +1083,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1084,6 +1099,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1110,6 +1126,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1278,6 +1296,8 @@ class NewSubscriptionPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice#cadence module Cadence extend Orb::Enum @@ -1295,6 +1315,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice#package_config class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -1318,6 +1339,7 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1344,6 +1366,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1358,6 +1382,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1384,6 +1409,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1552,6 +1579,8 @@ class NewSubscriptionMatrixPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice#cadence module Cadence extend Orb::Enum @@ -1569,6 +1598,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -1627,6 +1657,7 @@ class MatrixValue < Orb::BaseModel end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1653,6 +1684,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1667,6 +1700,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1693,6 +1727,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1861,6 +1897,8 @@ class NewSubscriptionTieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice#cadence module Cadence extend Orb::Enum @@ -1878,6 +1916,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice#tiered_config class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -1927,6 +1966,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1953,6 +1993,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -1967,6 +2009,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -1993,6 +2036,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2161,6 +2206,8 @@ class NewSubscriptionTieredBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#cadence module Cadence extend Orb::Enum @@ -2178,6 +2225,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#tiered_bps_config class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -2235,6 +2283,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2261,6 +2310,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2275,6 +2326,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2301,6 +2353,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2468,6 +2522,7 @@ class NewSubscriptionBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice#bps_config class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -2491,6 +2546,8 @@ class BpsConfig < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice#cadence module Cadence extend Orb::Enum @@ -2508,6 +2565,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2534,6 +2592,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2548,6 +2608,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2574,6 +2635,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2741,6 +2804,7 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -2792,6 +2856,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#cadence module Cadence extend Orb::Enum @@ -2809,6 +2875,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2835,6 +2902,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -2849,6 +2918,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -2875,6 +2945,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3042,6 +3114,7 @@ class NewSubscriptionBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice#bulk_config class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -3085,6 +3158,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice#cadence module Cadence extend Orb::Enum @@ -3102,6 +3177,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3128,6 +3204,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3142,6 +3220,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3168,6 +3247,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3335,6 +3416,8 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice#cadence module Cadence extend Orb::Enum @@ -3352,6 +3435,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3378,6 +3462,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3392,6 +3478,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3418,6 +3505,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3585,6 +3674,8 @@ class NewSubscriptionTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -3602,6 +3693,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3628,6 +3720,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3642,6 +3736,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3668,6 +3763,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3835,6 +3932,8 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice#cadence module Cadence extend Orb::Enum @@ -3852,6 +3951,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3878,6 +3978,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -3892,6 +3994,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -3918,6 +4021,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4085,6 +4190,8 @@ class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice#cadence module Cadence extend Orb::Enum @@ -4102,6 +4209,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4128,6 +4236,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4142,6 +4252,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4168,6 +4279,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4335,6 +4448,8 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice#cadence module Cadence extend Orb::Enum @@ -4352,6 +4467,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4378,6 +4494,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4392,6 +4510,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4418,6 +4537,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4585,6 +4706,8 @@ class NewSubscriptionTierWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -4602,6 +4725,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4628,6 +4752,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4642,6 +4768,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4668,6 +4795,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4835,6 +4964,8 @@ class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -4852,6 +4983,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4878,6 +5010,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -4892,6 +5026,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -4918,6 +5053,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5085,6 +5222,8 @@ class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#cadence module Cadence extend Orb::Enum @@ -5102,6 +5241,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5128,6 +5268,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5142,6 +5284,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5168,6 +5311,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5335,6 +5480,8 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#cadence module Cadence extend Orb::Enum @@ -5352,6 +5499,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5378,6 +5526,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5392,6 +5542,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5418,6 +5569,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5585,6 +5738,8 @@ class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -5602,6 +5757,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5628,6 +5784,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5642,6 +5800,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5668,6 +5827,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5835,6 +5996,8 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#cadence module Cadence extend Orb::Enum @@ -5852,6 +6015,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5878,6 +6042,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -5892,6 +6058,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -5918,6 +6085,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6085,6 +6254,8 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#cadence module Cadence extend Orb::Enum @@ -6102,6 +6273,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6128,6 +6300,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6142,6 +6316,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6168,6 +6343,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6335,6 +6512,8 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#cadence module Cadence extend Orb::Enum @@ -6352,6 +6531,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6378,6 +6558,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6392,6 +6574,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6418,6 +6601,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6585,6 +6770,8 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -6602,6 +6789,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6628,6 +6816,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6642,6 +6832,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6668,6 +6859,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6835,6 +7028,8 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#cadence module Cadence extend Orb::Enum @@ -6852,6 +7047,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6878,6 +7074,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -6892,6 +7090,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -6918,6 +7117,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7085,6 +7286,8 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#cadence module Cadence extend Orb::Enum @@ -7102,6 +7305,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7128,6 +7332,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7142,6 +7348,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7168,6 +7375,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7335,6 +7544,8 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -7352,6 +7563,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7378,6 +7590,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7392,6 +7606,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -7418,6 +7633,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -7551,6 +7768,8 @@ class ReplaceAdjustment < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The definition of a new adjustment to create and add to the subscription. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment#adjustment module Adjustment extend Orb::Union @@ -7879,6 +8098,7 @@ class ReplacePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice#allocation_price class AllocationPrice < Orb::BaseModel # @!attribute amount # An amount of the currency to allocate to the customer at the specified cadence. @@ -7920,6 +8140,8 @@ class AllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence at which to allocate the amount to the customer. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice#cadence module Cadence extend Orb::Enum @@ -7975,6 +8197,7 @@ class Discount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount#discount_type module DiscountType extend Orb::Enum @@ -7991,6 +8214,8 @@ module DiscountType end # The definition of a new price to create and add to the subscription. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice#price module Price extend Orb::Union @@ -8224,6 +8449,8 @@ class NewSubscriptionUnitPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice#cadence module Cadence extend Orb::Enum @@ -8241,6 +8468,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice#unit_config class UnitConfig < Orb::BaseModel # @!attribute unit_amount # Rate per unit of usage @@ -8256,6 +8484,7 @@ class UnitConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8282,6 +8511,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8296,6 +8527,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8322,6 +8554,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8490,6 +8724,8 @@ class NewSubscriptionPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice#cadence module Cadence extend Orb::Enum @@ -8507,6 +8743,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice#package_config class PackageConfig < Orb::BaseModel # @!attribute package_amount # A currency amount to rate usage by @@ -8530,6 +8767,7 @@ class PackageConfig < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8556,6 +8794,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8570,6 +8810,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8596,6 +8837,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8764,6 +9007,8 @@ class NewSubscriptionMatrixPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#cadence module Cadence extend Orb::Enum @@ -8781,6 +9026,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#matrix_config class MatrixConfig < Orb::BaseModel # @!attribute default_unit_amount # Default per unit rate for any usage not bucketed into a specified matrix_value @@ -8839,6 +9085,7 @@ class MatrixValue < Orb::BaseModel end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8865,6 +9112,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -8879,6 +9128,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -8905,6 +9155,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9073,6 +9325,8 @@ class NewSubscriptionTieredPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice#cadence module Cadence extend Orb::Enum @@ -9090,6 +9344,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice#tiered_config class TieredConfig < Orb::BaseModel # @!attribute tiers # Tiers for rating based on total usage quantities into the specified tier @@ -9139,6 +9394,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9165,6 +9421,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9179,6 +9437,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9205,6 +9464,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9373,6 +9634,8 @@ class NewSubscriptionTieredBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#cadence module Cadence extend Orb::Enum @@ -9390,6 +9653,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#tiered_bps_config class TieredBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified @@ -9447,6 +9711,7 @@ class Tier < Orb::BaseModel end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9473,6 +9738,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9487,6 +9754,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9513,6 +9781,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9680,6 +9950,7 @@ class NewSubscriptionBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice#bps_config class BpsConfig < Orb::BaseModel # @!attribute bps # Basis point take rate per event @@ -9703,6 +9974,8 @@ class BpsConfig < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice#cadence module Cadence extend Orb::Enum @@ -9720,6 +9993,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9746,6 +10020,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9760,6 +10036,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -9786,6 +10063,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -9953,6 +10232,7 @@ class NewSubscriptionBulkBpsPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#bulk_bps_config class BulkBpsConfig < Orb::BaseModel # @!attribute tiers # Tiers for a bulk BPS pricing model where all usage is aggregated to a single @@ -10004,6 +10284,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#cadence module Cadence extend Orb::Enum @@ -10021,6 +10303,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10047,6 +10330,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10061,6 +10346,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10087,6 +10373,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10254,6 +10542,7 @@ class NewSubscriptionBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice#bulk_config class BulkConfig < Orb::BaseModel # @!attribute tiers # Bulk tiers for rating based on total usage volume @@ -10297,6 +10586,8 @@ class Tier < Orb::BaseModel end # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice#cadence module Cadence extend Orb::Enum @@ -10314,6 +10605,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10340,6 +10632,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10354,6 +10648,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10380,6 +10675,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10547,6 +10844,8 @@ class NewSubscriptionThresholdTotalAmountPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice#cadence module Cadence extend Orb::Enum @@ -10564,6 +10863,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10590,6 +10890,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10604,6 +10906,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10630,6 +10933,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10797,6 +11102,8 @@ class NewSubscriptionTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -10814,6 +11121,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10840,6 +11148,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -10854,6 +11164,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -10880,6 +11191,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11047,6 +11360,8 @@ class NewSubscriptionTieredWithMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice#cadence module Cadence extend Orb::Enum @@ -11064,6 +11379,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11090,6 +11406,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11104,6 +11422,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11130,6 +11449,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11297,6 +11618,8 @@ class NewSubscriptionUnitWithPercentPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice#cadence module Cadence extend Orb::Enum @@ -11314,6 +11637,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11340,6 +11664,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11354,6 +11680,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11380,6 +11707,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11547,6 +11876,8 @@ class NewSubscriptionPackageWithAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice#cadence module Cadence extend Orb::Enum @@ -11564,6 +11895,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11590,6 +11922,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11604,6 +11938,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11630,6 +11965,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11797,6 +12134,8 @@ class NewSubscriptionTierWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -11814,6 +12153,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11840,6 +12180,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -11854,6 +12196,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -11880,6 +12223,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12047,6 +12392,8 @@ class NewSubscriptionUnitWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -12064,6 +12411,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12090,6 +12438,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12104,6 +12454,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12130,6 +12481,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12297,6 +12650,8 @@ class NewSubscriptionGroupedAllocationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice#cadence module Cadence extend Orb::Enum @@ -12314,6 +12669,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12340,6 +12696,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12354,6 +12712,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12380,6 +12739,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12547,6 +12908,8 @@ class NewSubscriptionGroupedWithProratedMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#cadence module Cadence extend Orb::Enum @@ -12564,6 +12927,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12590,6 +12954,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12604,6 +12970,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12630,6 +12997,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12797,6 +13166,8 @@ class NewSubscriptionBulkWithProrationPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice#cadence module Cadence extend Orb::Enum @@ -12814,6 +13185,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12840,6 +13212,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -12854,6 +13228,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -12880,6 +13255,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13047,6 +13424,8 @@ class NewSubscriptionScalableMatrixWithUnitPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#cadence module Cadence extend Orb::Enum @@ -13064,6 +13443,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13090,6 +13470,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13104,6 +13486,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13130,6 +13513,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13297,6 +13682,8 @@ class NewSubscriptionScalableMatrixWithTieredPricingPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#cadence module Cadence extend Orb::Enum @@ -13314,6 +13701,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13340,6 +13728,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13354,6 +13744,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13380,6 +13771,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13547,6 +13940,8 @@ class NewSubscriptionCumulativeGroupedBulkPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#cadence module Cadence extend Orb::Enum @@ -13564,6 +13959,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13590,6 +13986,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13604,6 +14002,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13630,6 +14029,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13797,6 +14198,8 @@ class NewSubscriptionMaxGroupTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -13814,6 +14217,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13840,6 +14244,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -13854,6 +14260,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -13880,6 +14287,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14047,6 +14456,8 @@ class NewSubscriptionGroupedWithMeteredMinimumPrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#cadence module Cadence extend Orb::Enum @@ -14064,6 +14475,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14090,6 +14502,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14104,6 +14518,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14130,6 +14545,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14297,6 +14714,8 @@ class NewSubscriptionMatrixWithDisplayNamePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#cadence module Cadence extend Orb::Enum @@ -14314,6 +14733,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14340,6 +14760,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14354,6 +14776,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14380,6 +14803,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14547,6 +14972,8 @@ class NewSubscriptionGroupedTieredPackagePrice < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The cadence to bill for this price on. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice#cadence module Cadence extend Orb::Enum @@ -14564,6 +14991,7 @@ module Cadence # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice#billing_cycle_configuration class BillingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14590,6 +15018,8 @@ class BillingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum @@ -14604,6 +15034,7 @@ module DurationUnit end end + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice#invoicing_cycle_configuration class InvoicingCycleConfiguration < Orb::BaseModel # @!attribute duration # The duration of the billing period. @@ -14630,6 +15061,8 @@ class InvoicingCycleConfiguration < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void # The unit of billing period duration. + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration#duration_unit module DurationUnit extend Orb::Enum diff --git a/lib/orb/models/subscription_schedule_plan_change_response.rb b/lib/orb/models/subscription_schedule_plan_change_response.rb index d67e3f4d..8f6b8ead 100644 --- a/lib/orb/models/subscription_schedule_plan_change_response.rb +++ b/lib/orb/models/subscription_schedule_plan_change_response.rb @@ -293,6 +293,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -667,6 +668,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1160,6 +1162,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1186,6 +1189,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#status module Status extend Orb::Enum @@ -1200,6 +1204,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionSchedulePlanChangeResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_trigger_phase_params.rb b/lib/orb/models/subscription_trigger_phase_params.rb index 9ce42ebb..1de831b6 100644 --- a/lib/orb/models/subscription_trigger_phase_params.rb +++ b/lib/orb/models/subscription_trigger_phase_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#trigger_phase class SubscriptionTriggerPhaseParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_trigger_phase_response.rb b/lib/orb/models/subscription_trigger_phase_response.rb index 129d7aaf..295d4453 100644 --- a/lib/orb/models/subscription_trigger_phase_response.rb +++ b/lib/orb/models/subscription_trigger_phase_response.rb @@ -293,6 +293,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -667,6 +668,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionTriggerPhaseResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1160,6 +1162,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionTriggerPhaseResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1186,6 +1189,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionTriggerPhaseResponse#status module Status extend Orb::Enum @@ -1200,6 +1204,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionTriggerPhaseResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_unschedule_cancellation_params.rb b/lib/orb/models/subscription_unschedule_cancellation_params.rb index 6c827218..139cc6e4 100644 --- a/lib/orb/models/subscription_unschedule_cancellation_params.rb +++ b/lib/orb/models/subscription_unschedule_cancellation_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#unschedule_cancellation class SubscriptionUnscheduleCancellationParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_unschedule_cancellation_response.rb b/lib/orb/models/subscription_unschedule_cancellation_response.rb index f851f16b..a18f7389 100644 --- a/lib/orb/models/subscription_unschedule_cancellation_response.rb +++ b/lib/orb/models/subscription_unschedule_cancellation_response.rb @@ -293,6 +293,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -667,6 +668,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1160,6 +1162,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1186,6 +1189,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#status module Status extend Orb::Enum @@ -1200,6 +1204,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionUnscheduleCancellationResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb index 68650373..84746e0a 100644 --- a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +++ b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#unschedule_fixed_fee_quantity_updates class SubscriptionUnscheduleFixedFeeQuantityUpdatesParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 0d9d6315..b918b2c7 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 @@ -293,6 +293,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -667,6 +668,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1164,6 +1166,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1190,6 +1193,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#status module Status extend Orb::Enum @@ -1204,6 +1208,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb b/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb index f2b294eb..9830f11d 100644 --- a/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +++ b/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#unschedule_pending_plan_changes class SubscriptionUnschedulePendingPlanChangesParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 c405536a..d68d524f 100644 --- a/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +++ b/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb @@ -293,6 +293,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -667,6 +668,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1160,6 +1162,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1186,6 +1189,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#status module Status extend Orb::Enum @@ -1200,6 +1204,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # 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 5152754a..909f76a8 100644 --- a/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +++ b/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#update_fixed_fee_quantity class SubscriptionUpdateFixedFeeQuantityParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter 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 2ba39f77..bdd3ada4 100644 --- a/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +++ b/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb @@ -293,6 +293,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -667,6 +668,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1160,6 +1162,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1186,6 +1189,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#status module Status extend Orb::Enum @@ -1200,6 +1204,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_update_params.rb b/lib/orb/models/subscription_update_params.rb index a9d82289..687a9f4c 100644 --- a/lib/orb/models/subscription_update_params.rb +++ b/lib/orb/models/subscription_update_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#update class SubscriptionUpdateParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_update_trial_params.rb b/lib/orb/models/subscription_update_trial_params.rb index 2533dd43..b59e5ddf 100644 --- a/lib/orb/models/subscription_update_trial_params.rb +++ b/lib/orb/models/subscription_update_trial_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#update_trial class SubscriptionUpdateTrialParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/subscription_update_trial_response.rb b/lib/orb/models/subscription_update_trial_response.rb index 632611d2..e2b05007 100644 --- a/lib/orb/models/subscription_update_trial_response.rb +++ b/lib/orb/models/subscription_update_trial_response.rb @@ -291,6 +291,7 @@ class AdjustmentInterval < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval#adjustment module Adjustment extend Orb::Union @@ -665,6 +666,7 @@ class PlanPhaseMaximumAdjustment < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUpdateTrialResponse#billing_cycle_anchor_configuration class BillingCycleAnchorConfiguration < Orb::BaseModel # @!attribute day # The day of the month on which the billing cycle is anchored. If the maximum @@ -1158,6 +1160,7 @@ class FixedFeeQuantityTransition < Orb::BaseModel end end + # @see Orb::Models::SubscriptionUpdateTrialResponse#redeemed_coupon class RedeemedCoupon < Orb::BaseModel # @!attribute coupon_id # @@ -1184,6 +1187,7 @@ class RedeemedCoupon < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionUpdateTrialResponse#status module Status extend Orb::Enum @@ -1198,6 +1202,7 @@ module Status # def self.values; end end + # @see Orb::Models::SubscriptionUpdateTrialResponse#trial_info class TrialInfo < Orb::BaseModel # @!attribute end_date # diff --git a/lib/orb/models/subscription_usage.rb b/lib/orb/models/subscription_usage.rb index b1faf73a..a5402596 100644 --- a/lib/orb/models/subscription_usage.rb +++ b/lib/orb/models/subscription_usage.rb @@ -50,6 +50,7 @@ class Data < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -96,6 +97,7 @@ class Usage < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#view_mode module ViewMode extend Orb::Enum @@ -163,6 +165,7 @@ class Data < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#billable_metric class BillableMetric < Orb::BaseModel # @!attribute id # @@ -183,6 +186,7 @@ class BillableMetric < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#metric_group class MetricGroup < Orb::BaseModel # @!attribute property_key # @@ -229,6 +233,7 @@ class Usage < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void end + # @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#view_mode module ViewMode extend Orb::Enum diff --git a/lib/orb/models/top_level_ping_params.rb b/lib/orb/models/top_level_ping_params.rb index 2fa84e0b..24d366a7 100644 --- a/lib/orb/models/top_level_ping_params.rb +++ b/lib/orb/models/top_level_ping_params.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::TopLevel#ping class TopLevelPingParams < Orb::BaseModel # @!parse # extend Orb::Type::RequestParameters::Converter diff --git a/lib/orb/models/trial_discount.rb b/lib/orb/models/trial_discount.rb index a7e99b13..f29f1a41 100644 --- a/lib/orb/models/trial_discount.rb +++ b/lib/orb/models/trial_discount.rb @@ -52,6 +52,7 @@ class TrialDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::TrialDiscount#discount_type module DiscountType extend Orb::Enum diff --git a/lib/orb/models/usage_discount.rb b/lib/orb/models/usage_discount.rb index 493e09e0..019bc511 100644 --- a/lib/orb/models/usage_discount.rb +++ b/lib/orb/models/usage_discount.rb @@ -37,6 +37,7 @@ class UsageDiscount < Orb::BaseModel # def initialize: (Hash | Orb::BaseModel) -> void + # @see Orb::Models::UsageDiscount#discount_type module DiscountType extend Orb::Enum diff --git a/lib/orb/resources/alerts.rb b/lib/orb/resources/alerts.rb index 6b713009..b91e9bec 100644 --- a/lib/orb/resources/alerts.rb +++ b/lib/orb/resources/alerts.rb @@ -12,6 +12,8 @@ class Alerts # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Alert] + # + # @see Orb::Models::AlertRetrieveParams def retrieve(alert_id, params = {}) @client.request( method: :get, @@ -32,6 +34,8 @@ def retrieve(alert_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Alert] + # + # @see Orb::Models::AlertUpdateParams def update(alert_configuration_id, params) parsed, options = Orb::Models::AlertUpdateParams.dump_request(params) @client.request( @@ -79,6 +83,8 @@ def update(alert_configuration_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::AlertListParams def list(params = {}) parsed, options = Orb::Models::AlertListParams.dump_request(params) @client.request( @@ -113,6 +119,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Alert] + # + # @see Orb::Models::AlertCreateForCustomerParams def create_for_customer(customer_id, params) parsed, options = Orb::Models::AlertCreateForCustomerParams.dump_request(params) @client.request( @@ -146,6 +154,8 @@ def create_for_customer(customer_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Alert] + # + # @see Orb::Models::AlertCreateForExternalCustomerParams def create_for_external_customer(external_customer_id, params) parsed, options = Orb::Models::AlertCreateForExternalCustomerParams.dump_request(params) @client.request( @@ -182,6 +192,8 @@ def create_for_external_customer(external_customer_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Alert] + # + # @see Orb::Models::AlertCreateForSubscriptionParams def create_for_subscription(subscription_id, params) parsed, options = Orb::Models::AlertCreateForSubscriptionParams.dump_request(params) @client.request( @@ -206,6 +218,8 @@ def create_for_subscription(subscription_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Alert] + # + # @see Orb::Models::AlertDisableParams def disable(alert_configuration_id, params = {}) parsed, options = Orb::Models::AlertDisableParams.dump_request(params) @client.request( @@ -230,6 +244,8 @@ def disable(alert_configuration_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Alert] + # + # @see Orb::Models::AlertEnableParams def enable(alert_configuration_id, params = {}) parsed, options = Orb::Models::AlertEnableParams.dump_request(params) @client.request( @@ -241,6 +257,8 @@ def enable(alert_configuration_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/coupons.rb b/lib/orb/resources/coupons.rb index d9d9f89f..b3534e03 100644 --- a/lib/orb/resources/coupons.rb +++ b/lib/orb/resources/coupons.rb @@ -24,6 +24,8 @@ class Coupons # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Coupon] + # + # @see Orb::Models::CouponCreateParams def create(params) parsed, options = Orb::Models::CouponCreateParams.dump_request(params) @client.request( @@ -57,6 +59,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::CouponListParams def list(params = {}) parsed, options = Orb::Models::CouponListParams.dump_request(params) @client.request( @@ -80,6 +84,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Coupon] + # + # @see Orb::Models::CouponArchiveParams def archive(coupon_id, params = {}) @client.request( method: :post, @@ -100,6 +106,8 @@ def archive(coupon_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Coupon] + # + # @see Orb::Models::CouponFetchParams def fetch(coupon_id, params = {}) @client.request( method: :get, @@ -109,6 +117,8 @@ def fetch(coupon_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/coupons/subscriptions.rb b/lib/orb/resources/coupons/subscriptions.rb index 5e7f9d01..7c054ee2 100644 --- a/lib/orb/resources/coupons/subscriptions.rb +++ b/lib/orb/resources/coupons/subscriptions.rb @@ -21,6 +21,8 @@ class Subscriptions # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::Coupons::SubscriptionListParams def list(coupon_id, params = {}) parsed, options = Orb::Models::Coupons::SubscriptionListParams.dump_request(params) @client.request( @@ -33,6 +35,8 @@ def list(coupon_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/credit_notes.rb b/lib/orb/resources/credit_notes.rb index ba5635c7..c7fe77c5 100644 --- a/lib/orb/resources/credit_notes.rb +++ b/lib/orb/resources/credit_notes.rb @@ -17,6 +17,8 @@ class CreditNotes # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::CreditNote] + # + # @see Orb::Models::CreditNoteCreateParams def create(params) parsed, options = Orb::Models::CreditNoteCreateParams.dump_request(params) @client.request( @@ -50,6 +52,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::CreditNoteListParams def list(params = {}) parsed, options = Orb::Models::CreditNoteListParams.dump_request(params) @client.request( @@ -72,6 +76,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::CreditNote] + # + # @see Orb::Models::CreditNoteFetchParams def fetch(credit_note_id, params = {}) @client.request( method: :get, @@ -81,6 +87,8 @@ def fetch(credit_note_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/customers.rb b/lib/orb/resources/customers.rb index c9aa817c..ddd6be40 100644 --- a/lib/orb/resources/customers.rb +++ b/lib/orb/resources/customers.rb @@ -185,6 +185,8 @@ class Customers # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customer] + # + # @see Orb::Models::CustomerCreateParams def create(params) parsed, options = Orb::Models::CustomerCreateParams.dump_request(params) @client.request( @@ -361,6 +363,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customer] + # + # @see Orb::Models::CustomerUpdateParams def update(customer_id, params = {}) parsed, options = Orb::Models::CustomerUpdateParams.dump_request(params) @client.request( @@ -397,6 +401,8 @@ def update(customer_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::CustomerListParams def list(params = {}) parsed, options = Orb::Models::CustomerListParams.dump_request(params) @client.request( @@ -432,6 +438,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [nil] + # + # @see Orb::Models::CustomerDeleteParams def delete(customer_id, params = {}) @client.request( method: :delete, @@ -455,6 +463,8 @@ def delete(customer_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customer] + # + # @see Orb::Models::CustomerFetchParams def fetch(customer_id, params = {}) @client.request( method: :get, @@ -477,6 +487,8 @@ def fetch(customer_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customer] + # + # @see Orb::Models::CustomerFetchByExternalIDParams def fetch_by_external_id(external_customer_id, params = {}) @client.request( method: :get, @@ -500,6 +512,8 @@ def fetch_by_external_id(external_customer_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [nil] + # + # @see Orb::Models::CustomerSyncPaymentMethodsFromGatewayParams def sync_payment_methods_from_gateway(external_customer_id, params = {}) @client.request( method: :post, @@ -526,6 +540,8 @@ def sync_payment_methods_from_gateway(external_customer_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [nil] + # + # @see Orb::Models::CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, params = {}) @client.request( method: :post, @@ -699,6 +715,8 @@ def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, param # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customer] + # + # @see Orb::Models::CustomerUpdateByExternalIDParams def update_by_external_id(id, params = {}) parsed, options = Orb::Models::CustomerUpdateByExternalIDParams.dump_request(params) @client.request( @@ -710,6 +728,8 @@ def update_by_external_id(id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/customers/balance_transactions.rb b/lib/orb/resources/customers/balance_transactions.rb index 84ea261d..32333d7d 100644 --- a/lib/orb/resources/customers/balance_transactions.rb +++ b/lib/orb/resources/customers/balance_transactions.rb @@ -20,6 +20,8 @@ class BalanceTransactions # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customers::BalanceTransactionCreateResponse] + # + # @see Orb::Models::Customers::BalanceTransactionCreateParams def create(customer_id, params) parsed, options = Orb::Models::Customers::BalanceTransactionCreateParams.dump_request(params) @client.request( @@ -80,6 +82,8 @@ def create(customer_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::Customers::BalanceTransactionListParams def list(customer_id, params = {}) parsed, options = Orb::Models::Customers::BalanceTransactionListParams.dump_request(params) @client.request( @@ -92,6 +96,8 @@ def list(customer_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/customers/costs.rb b/lib/orb/resources/customers/costs.rb index 6a633caa..db48144e 100644 --- a/lib/orb/resources/customers/costs.rb +++ b/lib/orb/resources/customers/costs.rb @@ -140,6 +140,8 @@ class Costs # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customers::CostListResponse] + # + # @see Orb::Models::Customers::CostListParams def list(customer_id, params = {}) parsed, options = Orb::Models::Customers::CostListParams.dump_request(params) @client.request( @@ -287,6 +289,8 @@ def list(customer_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customers::CostListByExternalIDResponse] + # + # @see Orb::Models::Customers::CostListByExternalIDParams def list_by_external_id(external_customer_id, params = {}) parsed, options = Orb::Models::Customers::CostListByExternalIDParams.dump_request(params) @client.request( @@ -298,6 +302,8 @@ def list_by_external_id(external_customer_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/customers/credits.rb b/lib/orb/resources/customers/credits.rb index cb159b78..c8a592c7 100644 --- a/lib/orb/resources/customers/credits.rb +++ b/lib/orb/resources/customers/credits.rb @@ -35,6 +35,8 @@ class Credits # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::Customers::CreditListParams def list(customer_id, params = {}) parsed, options = Orb::Models::Customers::CreditListParams.dump_request(params) @client.request( @@ -72,6 +74,8 @@ def list(customer_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::Customers::CreditListByExternalIDParams def list_by_external_id(external_customer_id, params = {}) parsed, options = Orb::Models::Customers::CreditListByExternalIDParams.dump_request(params) @client.request( @@ -84,6 +88,8 @@ def list_by_external_id(external_customer_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/customers/credits/ledger.rb b/lib/orb/resources/customers/credits/ledger.rb index 07d58f11..55fa875d 100644 --- a/lib/orb/resources/customers/credits/ledger.rb +++ b/lib/orb/resources/customers/credits/ledger.rb @@ -115,6 +115,8 @@ class Ledger # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::Customers::Credits::LedgerListParams def list(customer_id, params = {}) parsed, options = Orb::Models::Customers::Credits::LedgerListParams.dump_request(params) @client.request( @@ -282,6 +284,8 @@ def list(customer_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry] + # + # @see Orb::Models::Customers::Credits::LedgerCreateEntryParams def create_entry(customer_id, params) parsed, options = Orb::Models::Customers::Credits::LedgerCreateEntryParams.dump_request(params) @client.request( @@ -448,6 +452,8 @@ def create_entry(customer_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry] + # + # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams def create_entry_by_external_id(external_customer_id, params) parsed, options = Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams.dump_request(params) @@ -570,6 +576,8 @@ def create_entry_by_external_id(external_customer_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::Customers::Credits::LedgerListByExternalIDParams def list_by_external_id(external_customer_id, params = {}) parsed, options = Orb::Models::Customers::Credits::LedgerListByExternalIDParams.dump_request(params) @client.request( @@ -582,6 +590,8 @@ def list_by_external_id(external_customer_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/customers/credits/top_ups.rb b/lib/orb/resources/customers/credits/top_ups.rb index 099cf1bf..954bdafb 100644 --- a/lib/orb/resources/customers/credits/top_ups.rb +++ b/lib/orb/resources/customers/credits/top_ups.rb @@ -40,6 +40,8 @@ class TopUps # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customers::Credits::TopUpCreateResponse] + # + # @see Orb::Models::Customers::Credits::TopUpCreateParams def create(customer_id, params) parsed, options = Orb::Models::Customers::Credits::TopUpCreateParams.dump_request(params) @client.request( @@ -65,6 +67,8 @@ def create(customer_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::Customers::Credits::TopUpListParams def list(customer_id, params = {}) parsed, options = Orb::Models::Customers::Credits::TopUpListParams.dump_request(params) @client.request( @@ -89,6 +93,8 @@ def list(customer_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [nil] + # + # @see Orb::Models::Customers::Credits::TopUpDeleteParams def delete(top_up_id, params) parsed, options = Orb::Models::Customers::Credits::TopUpDeleteParams.dump_request(params) customer_id = @@ -138,6 +144,8 @@ def delete(top_up_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse] + # + # @see Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams def create_by_external_id(external_customer_id, params) parsed, options = Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams.dump_request(params) @client.request( @@ -161,6 +169,8 @@ def create_by_external_id(external_customer_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [nil] + # + # @see Orb::Models::Customers::Credits::TopUpDeleteByExternalIDParams def delete_by_external_id(top_up_id, params) parsed, options = Orb::Models::Customers::Credits::TopUpDeleteByExternalIDParams.dump_request(params) external_customer_id = @@ -193,6 +203,8 @@ def delete_by_external_id(top_up_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::Customers::Credits::TopUpListByExternalIDParams def list_by_external_id(external_customer_id, params = {}) parsed, options = Orb::Models::Customers::Credits::TopUpListByExternalIDParams.dump_request(params) @client.request( @@ -205,6 +217,8 @@ def list_by_external_id(external_customer_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/dimensional_price_groups.rb b/lib/orb/resources/dimensional_price_groups.rb index 02937c6b..1436e8b3 100644 --- a/lib/orb/resources/dimensional_price_groups.rb +++ b/lib/orb/resources/dimensional_price_groups.rb @@ -32,6 +32,8 @@ class DimensionalPriceGroups # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::DimensionalPriceGroup] + # + # @see Orb::Models::DimensionalPriceGroupCreateParams def create(params) parsed, options = Orb::Models::DimensionalPriceGroupCreateParams.dump_request(params) @client.request( @@ -52,6 +54,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::DimensionalPriceGroup] + # + # @see Orb::Models::DimensionalPriceGroupRetrieveParams def retrieve(dimensional_price_group_id, params = {}) @client.request( method: :get, @@ -73,6 +77,8 @@ def retrieve(dimensional_price_group_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::DimensionalPriceGroupListParams def list(params = {}) parsed, options = Orb::Models::DimensionalPriceGroupListParams.dump_request(params) @client.request( @@ -85,6 +91,8 @@ def list(params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb b/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb index c9e30bad..29ad355f 100644 --- a/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +++ b/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb @@ -13,6 +13,8 @@ class ExternalDimensionalPriceGroupID # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::DimensionalPriceGroup] + # + # @see Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDRetrieveParams def retrieve(external_dimensional_price_group_id, params = {}) @client.request( method: :get, @@ -25,6 +27,8 @@ def retrieve(external_dimensional_price_group_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/events.rb b/lib/orb/resources/events.rb index 82cc5c6d..405b6811 100644 --- a/lib/orb/resources/events.rb +++ b/lib/orb/resources/events.rb @@ -76,6 +76,8 @@ class Events # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::EventUpdateResponse] + # + # @see Orb::Models::EventUpdateParams def update(event_id, params) parsed, options = Orb::Models::EventUpdateParams.dump_request(params) @client.request( @@ -135,6 +137,8 @@ def update(event_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::EventDeprecateResponse] + # + # @see Orb::Models::EventDeprecateParams def deprecate(event_id, params = {}) @client.request( method: :put, @@ -362,6 +366,8 @@ def deprecate(event_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::EventIngestResponse] + # + # @see Orb::Models::EventIngestParams def ingest(params) parsed, options = Orb::Models::EventIngestParams.dump_request(params) query_params = [:backfill_id, :debug] @@ -407,6 +413,8 @@ def ingest(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::EventSearchResponse] + # + # @see Orb::Models::EventSearchParams def search(params) parsed, options = Orb::Models::EventSearchParams.dump_request(params) @client.request( @@ -418,6 +426,8 @@ def search(params) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/events/backfills.rb b/lib/orb/resources/events/backfills.rb index 6ca612b3..a804e118 100644 --- a/lib/orb/resources/events/backfills.rb +++ b/lib/orb/resources/events/backfills.rb @@ -72,6 +72,8 @@ class Backfills # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Events::BackfillCreateResponse] + # + # @see Orb::Models::Events::BackfillCreateParams def create(params) parsed, options = Orb::Models::Events::BackfillCreateParams.dump_request(params) @client.request( @@ -101,6 +103,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::Events::BackfillListParams def list(params = {}) parsed, options = Orb::Models::Events::BackfillListParams.dump_request(params) @client.request( @@ -125,6 +129,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Events::BackfillCloseResponse] + # + # @see Orb::Models::Events::BackfillCloseParams def close(backfill_id, params = {}) @client.request( method: :post, @@ -143,6 +149,8 @@ def close(backfill_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Events::BackfillFetchResponse] + # + # @see Orb::Models::Events::BackfillFetchParams def fetch(backfill_id, params = {}) @client.request( method: :get, @@ -167,6 +175,8 @@ def fetch(backfill_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Events::BackfillRevertResponse] + # + # @see Orb::Models::Events::BackfillRevertParams def revert(backfill_id, params = {}) @client.request( method: :post, @@ -176,6 +186,8 @@ def revert(backfill_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/events/volume.rb b/lib/orb/resources/events/volume.rb index 3ef45888..13e84158 100644 --- a/lib/orb/resources/events/volume.rb +++ b/lib/orb/resources/events/volume.rb @@ -38,6 +38,8 @@ class Volume # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Events::EventVolumes] + # + # @see Orb::Models::Events::VolumeListParams def list(params) parsed, options = Orb::Models::Events::VolumeListParams.dump_request(params) @client.request( @@ -49,6 +51,8 @@ def list(params) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/invoice_line_items.rb b/lib/orb/resources/invoice_line_items.rb index 2d0c2d9a..11e007a6 100644 --- a/lib/orb/resources/invoice_line_items.rb +++ b/lib/orb/resources/invoice_line_items.rb @@ -24,6 +24,8 @@ class InvoiceLineItems # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::InvoiceLineItemCreateResponse] + # + # @see Orb::Models::InvoiceLineItemCreateParams def create(params) parsed, options = Orb::Models::InvoiceLineItemCreateParams.dump_request(params) @client.request( @@ -35,6 +37,8 @@ def create(params) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/invoices.rb b/lib/orb/resources/invoices.rb index 27762ca1..33b68054 100644 --- a/lib/orb/resources/invoices.rb +++ b/lib/orb/resources/invoices.rb @@ -40,6 +40,8 @@ class Invoices # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Invoice] + # + # @see Orb::Models::InvoiceCreateParams def create(params) parsed, options = Orb::Models::InvoiceCreateParams.dump_request(params) @client.request( @@ -68,6 +70,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Invoice] + # + # @see Orb::Models::InvoiceUpdateParams def update(invoice_id, params = {}) parsed, options = Orb::Models::InvoiceUpdateParams.dump_request(params) @client.request( @@ -140,6 +144,8 @@ def update(invoice_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::InvoiceListParams def list(params = {}) parsed, options = Orb::Models::InvoiceListParams.dump_request(params) @client.request( @@ -162,6 +168,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Invoice] + # + # @see Orb::Models::InvoiceFetchParams def fetch(invoice_id, params = {}) @client.request( method: :get, @@ -182,6 +190,8 @@ def fetch(invoice_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::InvoiceFetchUpcomingResponse] + # + # @see Orb::Models::InvoiceFetchUpcomingParams def fetch_upcoming(params) parsed, options = Orb::Models::InvoiceFetchUpcomingParams.dump_request(params) @client.request( @@ -213,6 +223,8 @@ def fetch_upcoming(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Invoice] + # + # @see Orb::Models::InvoiceIssueParams def issue(invoice_id, params = {}) parsed, options = Orb::Models::InvoiceIssueParams.dump_request(params) @client.request( @@ -240,6 +252,8 @@ def issue(invoice_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Invoice] + # + # @see Orb::Models::InvoiceMarkPaidParams def mark_paid(invoice_id, params) parsed, options = Orb::Models::InvoiceMarkPaidParams.dump_request(params) @client.request( @@ -261,6 +275,8 @@ def mark_paid(invoice_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Invoice] + # + # @see Orb::Models::InvoicePayParams def pay(invoice_id, params = {}) @client.request( method: :post, @@ -289,6 +305,8 @@ def pay(invoice_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Invoice] + # + # @see Orb::Models::InvoiceVoidParams def void(invoice_id, params = {}) @client.request( method: :post, @@ -298,6 +316,8 @@ def void(invoice_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/items.rb b/lib/orb/resources/items.rb index 48ab5c11..f6cda68f 100644 --- a/lib/orb/resources/items.rb +++ b/lib/orb/resources/items.rb @@ -12,6 +12,8 @@ class Items # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Item] + # + # @see Orb::Models::ItemCreateParams def create(params) parsed, options = Orb::Models::ItemCreateParams.dump_request(params) @client.request(method: :post, path: "items", body: parsed, model: Orb::Models::Item, options: options) @@ -30,6 +32,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Item] + # + # @see Orb::Models::ItemUpdateParams def update(item_id, params = {}) parsed, options = Orb::Models::ItemUpdateParams.dump_request(params) @client.request( @@ -54,6 +58,8 @@ def update(item_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::ItemListParams def list(params = {}) parsed, options = Orb::Models::ItemListParams.dump_request(params) @client.request( @@ -75,6 +81,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Item] + # + # @see Orb::Models::ItemFetchParams def fetch(item_id, params = {}) @client.request( method: :get, @@ -84,6 +92,8 @@ def fetch(item_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/metrics.rb b/lib/orb/resources/metrics.rb index 9a731165..62d2dc30 100644 --- a/lib/orb/resources/metrics.rb +++ b/lib/orb/resources/metrics.rb @@ -24,6 +24,8 @@ class Metrics # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::BillableMetric] + # + # @see Orb::Models::MetricCreateParams def create(params) parsed, options = Orb::Models::MetricCreateParams.dump_request(params) @client.request( @@ -50,6 +52,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::BillableMetric] + # + # @see Orb::Models::MetricUpdateParams def update(metric_id, params = {}) parsed, options = Orb::Models::MetricUpdateParams.dump_request(params) @client.request( @@ -83,6 +87,8 @@ def update(metric_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::MetricListParams def list(params = {}) parsed, options = Orb::Models::MetricListParams.dump_request(params) @client.request( @@ -105,6 +111,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::BillableMetric] + # + # @see Orb::Models::MetricFetchParams def fetch(metric_id, params = {}) @client.request( method: :get, @@ -114,6 +122,8 @@ def fetch(metric_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/plans.rb b/lib/orb/resources/plans.rb index c380e1fe..a03e2350 100644 --- a/lib/orb/resources/plans.rb +++ b/lib/orb/resources/plans.rb @@ -36,6 +36,8 @@ class Plans # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Plan] + # + # @see Orb::Models::PlanCreateParams def create(params) parsed, options = Orb::Models::PlanCreateParams.dump_request(params) @client.request(method: :post, path: "plans", body: parsed, model: Orb::Models::Plan, options: options) @@ -61,6 +63,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Plan] + # + # @see Orb::Models::PlanUpdateParams def update(plan_id, params = {}) parsed, options = Orb::Models::PlanUpdateParams.dump_request(params) @client.request( @@ -98,6 +102,8 @@ def update(plan_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::PlanListParams def list(params = {}) parsed, options = Orb::Models::PlanListParams.dump_request(params) @client.request( @@ -135,6 +141,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Plan] + # + # @see Orb::Models::PlanFetchParams def fetch(plan_id, params = {}) @client.request( method: :get, @@ -144,6 +152,8 @@ def fetch(plan_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/plans/external_plan_id.rb b/lib/orb/resources/plans/external_plan_id.rb index 1586316b..0be1b662 100644 --- a/lib/orb/resources/plans/external_plan_id.rb +++ b/lib/orb/resources/plans/external_plan_id.rb @@ -24,6 +24,8 @@ class ExternalPlanID # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Plan] + # + # @see Orb::Models::Plans::ExternalPlanIDUpdateParams def update(other_external_plan_id, params = {}) parsed, options = Orb::Models::Plans::ExternalPlanIDUpdateParams.dump_request(params) @client.request( @@ -59,6 +61,8 @@ def update(other_external_plan_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Plan] + # + # @see Orb::Models::Plans::ExternalPlanIDFetchParams def fetch(external_plan_id, params = {}) @client.request( method: :get, @@ -68,6 +72,8 @@ def fetch(external_plan_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/prices.rb b/lib/orb/resources/prices.rb index 4124b506..b96d58de 100644 --- a/lib/orb/resources/prices.rb +++ b/lib/orb/resources/prices.rb @@ -113,6 +113,8 @@ class Prices # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @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] + # + # @see Orb::Models::PriceCreateParams def create(params) parsed, options = Orb::Models::PriceCreateParams.dump_request(params) @client.request(method: :post, path: "prices", body: parsed, model: Orb::Models::Price, options: options) @@ -133,6 +135,8 @@ def create(params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @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] + # + # @see Orb::Models::PriceUpdateParams def update(price_id, params = {}) parsed, options = Orb::Models::PriceUpdateParams.dump_request(params) @client.request( @@ -157,6 +161,8 @@ def update(price_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::PriceListParams def list(params = {}) parsed, options = Orb::Models::PriceListParams.dump_request(params) @client.request( @@ -214,6 +220,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::PriceEvaluateResponse] + # + # @see Orb::Models::PriceEvaluateParams def evaluate(price_id, params) parsed, options = Orb::Models::PriceEvaluateParams.dump_request(params) @client.request( @@ -234,6 +242,8 @@ def evaluate(price_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @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] + # + # @see Orb::Models::PriceFetchParams def fetch(price_id, params = {}) @client.request( method: :get, @@ -243,6 +253,8 @@ def fetch(price_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/prices/external_price_id.rb b/lib/orb/resources/prices/external_price_id.rb index 1e3cad49..a20af3eb 100644 --- a/lib/orb/resources/prices/external_price_id.rb +++ b/lib/orb/resources/prices/external_price_id.rb @@ -19,6 +19,8 @@ class ExternalPriceID # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @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] + # + # @see Orb::Models::Prices::ExternalPriceIDUpdateParams def update(external_price_id, params = {}) parsed, options = Orb::Models::Prices::ExternalPriceIDUpdateParams.dump_request(params) @client.request( @@ -41,6 +43,8 @@ def update(external_price_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @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] + # + # @see Orb::Models::Prices::ExternalPriceIDFetchParams def fetch(external_price_id, params = {}) @client.request( method: :get, @@ -50,6 +54,8 @@ def fetch(external_price_id, params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/subscriptions.rb b/lib/orb/resources/subscriptions.rb index 56b447c0..e89728f9 100644 --- a/lib/orb/resources/subscriptions.rb +++ b/lib/orb/resources/subscriptions.rb @@ -358,6 +358,8 @@ class Subscriptions # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionCreateResponse] + # + # @see Orb::Models::SubscriptionCreateParams def create(params = {}) parsed, options = Orb::Models::SubscriptionCreateParams.dump_request(params) @client.request( @@ -400,6 +402,8 @@ def create(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Subscription] + # + # @see Orb::Models::SubscriptionUpdateParams def update(subscription_id, params = {}) parsed, options = Orb::Models::SubscriptionUpdateParams.dump_request(params) @client.request( @@ -445,6 +449,8 @@ def update(subscription_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::SubscriptionListParams def list(params = {}) parsed, options = Orb::Models::SubscriptionListParams.dump_request(params) @client.request( @@ -535,6 +541,8 @@ def list(params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionCancelResponse] + # + # @see Orb::Models::SubscriptionCancelParams def cancel(subscription_id, params) parsed, options = Orb::Models::SubscriptionCancelParams.dump_request(params) @client.request( @@ -556,6 +564,8 @@ def cancel(subscription_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::Subscription] + # + # @see Orb::Models::SubscriptionFetchParams def fetch(subscription_id, params = {}) @client.request( method: :get, @@ -594,6 +604,8 @@ def fetch(subscription_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionFetchCostsResponse] + # + # @see Orb::Models::SubscriptionFetchCostsParams def fetch_costs(subscription_id, params = {}) parsed, options = Orb::Models::SubscriptionFetchCostsParams.dump_request(params) @client.request( @@ -630,6 +642,8 @@ def fetch_costs(subscription_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Page] + # + # @see Orb::Models::SubscriptionFetchScheduleParams def fetch_schedule(subscription_id, params = {}) parsed, options = Orb::Models::SubscriptionFetchScheduleParams.dump_request(params) @client.request( @@ -869,6 +883,8 @@ def fetch_schedule(subscription_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage] + # + # @see Orb::Models::SubscriptionFetchUsageParams def fetch_usage(subscription_id, params = {}) parsed, options = Orb::Models::SubscriptionFetchUsageParams.dump_request(params) @client.request( @@ -972,6 +988,8 @@ def fetch_usage(subscription_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionPriceIntervalsResponse] + # + # @see Orb::Models::SubscriptionPriceIntervalsParams def price_intervals(subscription_id, params = {}) parsed, options = Orb::Models::SubscriptionPriceIntervalsParams.dump_request(params) @client.request( @@ -1260,6 +1278,8 @@ def price_intervals(subscription_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionSchedulePlanChangeResponse] + # + # @see Orb::Models::SubscriptionSchedulePlanChangeParams def schedule_plan_change(subscription_id, params) parsed, options = Orb::Models::SubscriptionSchedulePlanChangeParams.dump_request(params) @client.request( @@ -1288,6 +1308,8 @@ def schedule_plan_change(subscription_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionTriggerPhaseResponse] + # + # @see Orb::Models::SubscriptionTriggerPhaseParams def trigger_phase(subscription_id, params = {}) parsed, options = Orb::Models::SubscriptionTriggerPhaseParams.dump_request(params) @client.request( @@ -1313,6 +1335,8 @@ def trigger_phase(subscription_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionUnscheduleCancellationResponse] + # + # @see Orb::Models::SubscriptionUnscheduleCancellationParams def unschedule_cancellation(subscription_id, params = {}) @client.request( method: :post, @@ -1337,6 +1361,8 @@ def unschedule_cancellation(subscription_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse] + # + # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesParams def unschedule_fixed_fee_quantity_updates(subscription_id, params) parsed, options = Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesParams.dump_request(params) @client.request( @@ -1358,6 +1384,8 @@ def unschedule_fixed_fee_quantity_updates(subscription_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse] + # + # @see Orb::Models::SubscriptionUnschedulePendingPlanChangesParams def unschedule_pending_plan_changes(subscription_id, params = {}) @client.request( method: :post, @@ -1405,6 +1433,8 @@ def unschedule_pending_plan_changes(subscription_id, params = {}) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse] + # + # @see Orb::Models::SubscriptionUpdateFixedFeeQuantityParams def update_fixed_fee_quantity(subscription_id, params) parsed, options = Orb::Models::SubscriptionUpdateFixedFeeQuantityParams.dump_request(params) @client.request( @@ -1448,6 +1478,8 @@ def update_fixed_fee_quantity(subscription_id, params) # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::SubscriptionUpdateTrialResponse] + # + # @see Orb::Models::SubscriptionUpdateTrialParams def update_trial(subscription_id, params) parsed, options = Orb::Models::SubscriptionUpdateTrialParams.dump_request(params) @client.request( @@ -1459,6 +1491,8 @@ def update_trial(subscription_id, params) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/lib/orb/resources/top_level.rb b/lib/orb/resources/top_level.rb index ddb12df7..393f131f 100644 --- a/lib/orb/resources/top_level.rb +++ b/lib/orb/resources/top_level.rb @@ -15,6 +15,8 @@ class TopLevel # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [Orb::Models::TopLevelPingResponse] + # + # @see Orb::Models::TopLevelPingParams def ping(params = {}) @client.request( method: :get, @@ -24,6 +26,8 @@ def ping(params = {}) ) end + # @api private + # # @param client [Orb::Client] def initialize(client:) @client = client diff --git a/rbi/lib/orb/resources/alerts.rbi b/rbi/lib/orb/resources/alerts.rbi index 4adf9589..eaa6da61 100644 --- a/rbi/lib/orb/resources/alerts.rbi +++ b/rbi/lib/orb/resources/alerts.rbi @@ -207,6 +207,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/coupons.rbi b/rbi/lib/orb/resources/coupons.rbi index 34810f16..0f65afe8 100644 --- a/rbi/lib/orb/resources/coupons.rbi +++ b/rbi/lib/orb/resources/coupons.rbi @@ -87,6 +87,7 @@ module Orb def fetch(coupon_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/coupons/subscriptions.rbi b/rbi/lib/orb/resources/coupons/subscriptions.rbi index d7caad01..f1a67f9e 100644 --- a/rbi/lib/orb/resources/coupons/subscriptions.rbi +++ b/rbi/lib/orb/resources/coupons/subscriptions.rbi @@ -28,6 +28,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/credit_notes.rbi b/rbi/lib/orb/resources/credit_notes.rbi index bdffc687..b8bdb7e4 100644 --- a/rbi/lib/orb/resources/credit_notes.rbi +++ b/rbi/lib/orb/resources/credit_notes.rbi @@ -65,6 +65,7 @@ module Orb def fetch(credit_note_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/customers.rbi b/rbi/lib/orb/resources/customers.rbi index fd2bef5d..31463508 100644 --- a/rbi/lib/orb/resources/customers.rbi +++ b/rbi/lib/orb/resources/customers.rbi @@ -705,6 +705,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/customers/balance_transactions.rbi b/rbi/lib/orb/resources/customers/balance_transactions.rbi index 6669f879..b7091ac2 100644 --- a/rbi/lib/orb/resources/customers/balance_transactions.rbi +++ b/rbi/lib/orb/resources/customers/balance_transactions.rbi @@ -82,6 +82,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/customers/costs.rbi b/rbi/lib/orb/resources/customers/costs.rbi index 42a33027..c8761e22 100644 --- a/rbi/lib/orb/resources/customers/costs.rbi +++ b/rbi/lib/orb/resources/customers/costs.rbi @@ -294,6 +294,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/customers/credits.rbi b/rbi/lib/orb/resources/customers/credits.rbi index 0242a83e..d9c6f590 100644 --- a/rbi/lib/orb/resources/customers/credits.rbi +++ b/rbi/lib/orb/resources/customers/credits.rbi @@ -78,6 +78,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/customers/credits/ledger.rbi b/rbi/lib/orb/resources/customers/credits/ledger.rbi index 759b9b53..2297f653 100644 --- a/rbi/lib/orb/resources/customers/credits/ledger.rbi +++ b/rbi/lib/orb/resources/customers/credits/ledger.rbi @@ -634,6 +634,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/customers/credits/top_ups.rbi b/rbi/lib/orb/resources/customers/credits/top_ups.rbi index 7501a295..ed7dbdcd 100644 --- a/rbi/lib/orb/resources/customers/credits/top_ups.rbi +++ b/rbi/lib/orb/resources/customers/credits/top_ups.rbi @@ -169,6 +169,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/dimensional_price_groups.rbi b/rbi/lib/orb/resources/dimensional_price_groups.rbi index 3c8f325f..3d938a6b 100644 --- a/rbi/lib/orb/resources/dimensional_price_groups.rbi +++ b/rbi/lib/orb/resources/dimensional_price_groups.rbi @@ -69,6 +69,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) 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 3151880d..670ab314 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 @@ -15,6 +15,7 @@ module Orb 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 diff --git a/rbi/lib/orb/resources/events.rbi b/rbi/lib/orb/resources/events.rbi index e3b90f09..4ad28f45 100644 --- a/rbi/lib/orb/resources/events.rbi +++ b/rbi/lib/orb/resources/events.rbi @@ -399,6 +399,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/events/backfills.rbi b/rbi/lib/orb/resources/events/backfills.rbi index f1aef9fe..4a9af1a8 100644 --- a/rbi/lib/orb/resources/events/backfills.rbi +++ b/rbi/lib/orb/resources/events/backfills.rbi @@ -151,6 +151,7 @@ module Orb def revert(backfill_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/events/volume.rbi b/rbi/lib/orb/resources/events/volume.rbi index 3cf15169..64ce2d40 100644 --- a/rbi/lib/orb/resources/events/volume.rbi +++ b/rbi/lib/orb/resources/events/volume.rbi @@ -47,6 +47,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/invoice_line_items.rbi b/rbi/lib/orb/resources/invoice_line_items.rbi index f57b326f..a88da564 100644 --- a/rbi/lib/orb/resources/invoice_line_items.rbi +++ b/rbi/lib/orb/resources/invoice_line_items.rbi @@ -35,6 +35,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/invoices.rbi b/rbi/lib/orb/resources/invoices.rbi index 18db847d..5b16586b 100644 --- a/rbi/lib/orb/resources/invoices.rbi +++ b/rbi/lib/orb/resources/invoices.rbi @@ -253,6 +253,7 @@ module Orb def void(invoice_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/items.rbi b/rbi/lib/orb/resources/items.rbi index bdce9a5e..376c50c4 100644 --- a/rbi/lib/orb/resources/items.rbi +++ b/rbi/lib/orb/resources/items.rbi @@ -56,6 +56,7 @@ module Orb def fetch(item_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/metrics.rbi b/rbi/lib/orb/resources/metrics.rbi index 1ac63c15..18dfcbff 100644 --- a/rbi/lib/orb/resources/metrics.rbi +++ b/rbi/lib/orb/resources/metrics.rbi @@ -93,6 +93,7 @@ module Orb def fetch(metric_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/plans.rbi b/rbi/lib/orb/resources/plans.rbi index 92feb998..38b1683a 100644 --- a/rbi/lib/orb/resources/plans.rbi +++ b/rbi/lib/orb/resources/plans.rbi @@ -161,6 +161,7 @@ module Orb def fetch(plan_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/plans/external_plan_id.rbi b/rbi/lib/orb/resources/plans/external_plan_id.rbi index a1cdc66f..44227da0 100644 --- a/rbi/lib/orb/resources/plans/external_plan_id.rbi +++ b/rbi/lib/orb/resources/plans/external_plan_id.rbi @@ -57,6 +57,7 @@ module Orb def fetch(external_plan_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/prices.rbi b/rbi/lib/orb/resources/prices.rbi index 087e9385..67e6f7b3 100644 --- a/rbi/lib/orb/resources/prices.rbi +++ b/rbi/lib/orb/resources/prices.rbi @@ -362,6 +362,7 @@ module Orb def fetch(price_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/prices/external_price_id.rbi b/rbi/lib/orb/resources/prices/external_price_id.rbi index 0d23469d..751edeab 100644 --- a/rbi/lib/orb/resources/prices/external_price_id.rbi +++ b/rbi/lib/orb/resources/prices/external_price_id.rbi @@ -100,6 +100,7 @@ module Orb def fetch(external_price_id, request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/subscriptions.rbi b/rbi/lib/orb/resources/subscriptions.rbi index 8b154e07..3f656513 100644 --- a/rbi/lib/orb/resources/subscriptions.rbi +++ b/rbi/lib/orb/resources/subscriptions.rbi @@ -1460,6 +1460,7 @@ module Orb ) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/orb/resources/top_level.rbi b/rbi/lib/orb/resources/top_level.rbi index 5e888789..5d4f8bee 100644 --- a/rbi/lib/orb/resources/top_level.rbi +++ b/rbi/lib/orb/resources/top_level.rbi @@ -16,6 +16,7 @@ module Orb def ping(request_options: {}) end + # @api private sig { params(client: Orb::Client).returns(T.attached_class) } def self.new(client:) end From 6416b4c1725c50e22dd7360ce0175651cc7b86fa Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 1 Apr 2025 16:33:23 +0000 Subject: [PATCH 3/8] chore: improve yard docs readability (#197) --- lib/orb/resources/alerts.rb | 117 ++-- lib/orb/resources/coupons.rb | 50 +- lib/orb/resources/coupons/subscriptions.rb | 14 +- lib/orb/resources/credit_notes.rb | 43 +- lib/orb/resources/customers.rb | 589 +++--------------- .../customers/balance_transactions.rb | 42 +- lib/orb/resources/customers/costs.rb | 44 +- lib/orb/resources/customers/credits.rb | 42 +- lib/orb/resources/customers/credits/ledger.rb | 188 ++---- .../resources/customers/credits/top_ups.rb | 118 ++-- lib/orb/resources/dimensional_price_groups.rb | 39 +- .../external_dimensional_price_group_id.rb | 7 +- lib/orb/resources/events.rb | 66 +- lib/orb/resources/events/backfills.rb | 68 +- lib/orb/resources/events/volume.rb | 23 +- lib/orb/resources/invoice_line_items.rb | 25 +- lib/orb/resources/invoices.rb | 183 ++---- lib/orb/resources/items.rb | 38 +- lib/orb/resources/metrics.rb | 63 +- lib/orb/resources/plans.rb | 87 +-- lib/orb/resources/plans/external_plan_id.rb | 24 +- lib/orb/resources/prices.rb | 198 ++---- lib/orb/resources/prices/external_price_id.rb | 19 +- lib/orb/resources/subscriptions.rb | 536 +++++----------- lib/orb/resources/top_level.rb | 4 +- 25 files changed, 745 insertions(+), 1882 deletions(-) diff --git a/lib/orb/resources/alerts.rb b/lib/orb/resources/alerts.rb index b91e9bec..b2041e65 100644 --- a/lib/orb/resources/alerts.rb +++ b/lib/orb/resources/alerts.rb @@ -5,11 +5,10 @@ module Resources class Alerts # This endpoint retrieves an alert by its ID. # - # @param alert_id [String] - # - # @param params [Orb::Models::AlertRetrieveParams, Hash{Symbol=>Object}] . + # @overload retrieve(alert_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param alert_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] # @@ -25,13 +24,11 @@ def retrieve(alert_id, params = {}) # This endpoint updates the thresholds of an alert. # - # @param alert_configuration_id [String] - # - # @param params [Orb::Models::AlertUpdateParams, Hash{Symbol=>Object}] . - # - # @option params [Array] :thresholds The thresholds that define the values at which the alert will be triggered. + # @overload update(alert_configuration_id, thresholds:, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param alert_configuration_id [String] + # @param thresholds [Array] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] # @@ -59,28 +56,18 @@ def update(alert_configuration_id, params) # This endpoint follows Orb's # [standardized pagination format](/api-reference/pagination). # - # @param params [Orb::Models::AlertListParams, Hash{Symbol=>Object}] . - # - # @option params [Time, nil] :created_at_gt - # - # @option params [Time, nil] :created_at_gte - # - # @option params [Time, nil] :created_at_lt - # - # @option params [Time, nil] :created_at_lte + # @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: {}) # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [String, nil] :customer_id Fetch alerts scoped to this customer_id - # - # @option params [String, nil] :external_customer_id Fetch alerts scoped to this external_customer_id - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [String, nil] :subscription_id Fetch alerts scoped to this subscription_id - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param created_at_gt [Time, nil] + # @param created_at_gte [Time, nil] + # @param created_at_lt [Time, nil] + # @param created_at_lte [Time, nil] + # @param cursor [String, nil] + # @param customer_id [String, nil] + # @param external_customer_id [String, nil] + # @param limit [Integer] + # @param subscription_id [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -106,17 +93,13 @@ def list(params = {}) # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not # require thresholds. # - # @param customer_id [String] - # - # @param params [Orb::Models::AlertCreateForCustomerParams, Hash{Symbol=>Object}] . - # - # @option params [String] :currency The case sensitive currency or custom pricing unit to use for this alert. - # - # @option params [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] :type The type of alert to create. This must be a valid alert type. - # - # @option params [Array, nil] :thresholds The thresholds that define the values at which the alert will be triggered. + # @overload create_for_customer(customer_id, currency:, type:, thresholds: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param currency [String] + # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] + # @param thresholds [Array, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] # @@ -141,17 +124,13 @@ def create_for_customer(customer_id, params) # while `credit_balance_depleted` and `credit_balance_recovered` alerts do not # require thresholds. # - # @param external_customer_id [String] - # - # @param params [Orb::Models::AlertCreateForExternalCustomerParams, Hash{Symbol=>Object}] . - # - # @option params [String] :currency The case sensitive currency or custom pricing unit to use for this alert. - # - # @option params [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] :type The type of alert to create. This must be a valid alert type. - # - # @option params [Array, nil] :thresholds The thresholds that define the values at which the alert will be triggered. + # @overload create_for_external_customer(external_customer_id, currency:, type:, thresholds: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_customer_id [String] + # @param currency [String] + # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] + # @param thresholds [Array, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] # @@ -179,17 +158,13 @@ def create_for_external_customer(external_customer_id, params) # per metric that is a part of the subscription. Alerts are triggered based on # usage or cost conditions met during the current billing cycle. # - # @param subscription_id [String] - # - # @param params [Orb::Models::AlertCreateForSubscriptionParams, Hash{Symbol=>Object}] . - # - # @option params [Array] :thresholds The thresholds that define the values at which the alert will be triggered. - # - # @option params [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] :type The type of alert to create. This must be a valid alert type. + # @overload create_for_subscription(subscription_id, thresholds:, type:, metric_id: nil, request_options: {}) # - # @option params [String, nil] :metric_id The metric to track usage for. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param thresholds [Array] + # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] + # @param metric_id [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] # @@ -209,13 +184,11 @@ def create_for_subscription(subscription_id, params) # a specific subscription, you must include the `subscription_id`. The # `subscription_id` is not required for customer or subscription level alerts. # - # @param alert_configuration_id [String] - # - # @param params [Orb::Models::AlertDisableParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :subscription_id Used to update the status of a plan alert scoped to this subscription_id + # @overload disable(alert_configuration_id, subscription_id: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param alert_configuration_id [String] + # @param subscription_id [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] # @@ -235,13 +208,11 @@ def disable(alert_configuration_id, params = {}) # specific subscription, you must include the `subscription_id`. The # `subscription_id` is not required for customer or subscription level alerts. # - # @param alert_configuration_id [String] - # - # @param params [Orb::Models::AlertEnableParams, Hash{Symbol=>Object}] . + # @overload enable(alert_configuration_id, subscription_id: nil, request_options: {}) # - # @option params [String, nil] :subscription_id Used to update the status of a plan alert scoped to this subscription_id - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param alert_configuration_id [String] + # @param subscription_id [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Alert] # diff --git a/lib/orb/resources/coupons.rb b/lib/orb/resources/coupons.rb index b3534e03..e3b08837 100644 --- a/lib/orb/resources/coupons.rb +++ b/lib/orb/resources/coupons.rb @@ -9,19 +9,13 @@ class Coupons # This endpoint allows the creation of coupons, which can then be redeemed at # subscription creation or plan change. # - # @param params [Orb::Models::CouponCreateParams, Hash{Symbol=>Object}] . + # @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {}) # - # @option params [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount] :discount - # - # @option params [String] :redemption_code This string can be used to redeem this coupon for a given subscription. - # - # @option params [Integer, nil] :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". - # - # @option params [Integer, nil] :max_redemptions The maximum number of redemptions allowed for this coupon before it is - # exhausted;`null` here means "unlimited". - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount] + # @param redemption_code [String] + # @param duration_in_months [Integer, nil] + # @param max_redemptions [Integer, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Coupon] # @@ -44,19 +38,13 @@ def create(params) # the next page of results if they exist. More information about pagination can be # found in the Pagination-metadata schema. # - # @param params [Orb::Models::CouponListParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [String, nil] :redemption_code Filter to coupons matching this redemption code. + # @overload list(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {}) # - # @option params [Boolean, nil] :show_archived Show archived coupons as well (by default, this endpoint only returns active - # coupons). - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param cursor [String, nil] + # @param limit [Integer] + # @param redemption_code [String, nil] + # @param show_archived [Boolean, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -77,11 +65,10 @@ def list(params = {}) # 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. # - # @param coupon_id [String] - # - # @param params [Orb::Models::CouponArchiveParams, Hash{Symbol=>Object}] . + # @overload archive(coupon_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param coupon_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Coupon] # @@ -99,11 +86,10 @@ def archive(coupon_id, params = {}) # code, use the [List coupons](list-coupons) endpoint with the redemption_code # parameter. # - # @param coupon_id [String] - # - # @param params [Orb::Models::CouponFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(coupon_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param coupon_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Coupon] # diff --git a/lib/orb/resources/coupons/subscriptions.rb b/lib/orb/resources/coupons/subscriptions.rb index 7c054ee2..e7af543b 100644 --- a/lib/orb/resources/coupons/subscriptions.rb +++ b/lib/orb/resources/coupons/subscriptions.rb @@ -9,16 +9,12 @@ class Subscriptions # the most recently created subscription. For a full discussion of the # subscription resource, see [Subscription](/core-concepts#subscription). # - # @param coupon_id [String] - # - # @param params [Orb::Models::Coupons::SubscriptionListParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # @overload list(coupon_id, cursor: nil, limit: nil, request_options: {}) # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param coupon_id [String] + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # diff --git a/lib/orb/resources/credit_notes.rb b/lib/orb/resources/credit_notes.rb index c7fe77c5..845c1f86 100644 --- a/lib/orb/resources/credit_notes.rb +++ b/lib/orb/resources/credit_notes.rb @@ -6,15 +6,12 @@ class CreditNotes # This endpoint is used to create a single # [`Credit Note`](/invoicing/credit-notes). # - # @param params [Orb::Models::CreditNoteCreateParams, Hash{Symbol=>Object}] . + # @overload create(line_items:, memo: nil, reason: nil, request_options: {}) # - # @option params [Array] :line_items - # - # @option params [String, nil] :memo An optional memo to attach to the credit note. - # - # @option params [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] :reason An optional reason for the credit note. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param line_items [Array] + # @param memo [String, nil] + # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::CreditNote] # @@ -34,22 +31,15 @@ def create(params) # subscription_id, or external_customer_id. The credit notes will be returned in # reverse chronological order by `creation_time`. # - # @param params [Orb::Models::CreditNoteListParams, Hash{Symbol=>Object}] . - # - # @option params [Time, nil] :created_at_gt - # - # @option params [Time, nil] :created_at_gte - # - # @option params [Time, nil] :created_at_lt + # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) # - # @option params [Time, nil] :created_at_lte - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param created_at_gt [Time, nil] + # @param created_at_gte [Time, nil] + # @param created_at_lt [Time, nil] + # @param created_at_lte [Time, nil] + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -69,11 +59,10 @@ def list(params = {}) # This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes) # given an identifier. # - # @param credit_note_id [String] - # - # @param params [Orb::Models::CreditNoteFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(credit_note_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param credit_note_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::CreditNote] # diff --git a/lib/orb/resources/customers.rb b/lib/orb/resources/customers.rb index ddd6be40..374f6c5e 100644 --- a/lib/orb/resources/customers.rb +++ b/lib/orb/resources/customers.rb @@ -25,164 +25,27 @@ class Customers # - [Timezone localization](/essentials/timezones) can be configured on a # per-customer basis by setting the `timezone` parameter # - # @param params [Orb::Models::CustomerCreateParams, Hash{Symbol=>Object}] . - # - # @option params [String] :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. - # - # @option params [String] :name The full name of the customer - # - # @option params [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil] :accounting_sync_configuration - # - # @option params [Array, nil] :additional_emails Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. - # - # @option params [Boolean, nil] :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. - # - # @option params [Orb::Models::CustomerCreateParams::BillingAddress, nil] :billing_address - # - # @option params [String, nil] :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. - # - # @option params [Boolean, nil] :email_delivery - # - # @option params [String, nil] :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. - # - # @option params [Orb::Models::CustomerCreateParams::Hierarchy, nil] :hierarchy The hierarchical relationships for this customer. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] :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. - # - # @option params [String, nil] :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. - # - # @option params [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil] :reporting_configuration - # - # @option params [Orb::Models::CustomerCreateParams::ShippingAddress, nil] :shipping_address - # - # @option params [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil] :tax_configuration - # - # @option params [Orb::Models::CustomerCreateParams::TaxID, nil] :tax_id Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. - # - # ### Supported Tax ID Countries and Types - # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | - # - # @option params [String, nil] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @overload create(email:, name:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, timezone: nil, request_options: {}) + # + # @param email [String] + # @param name [String] + # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil] + # @param additional_emails [Array, nil] + # @param auto_collection [Boolean, nil] + # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil] + # @param currency [String, nil] + # @param email_delivery [Boolean, nil] + # @param external_customer_id [String, nil] + # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] + # @param payment_provider_id [String, nil] + # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil] + # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil] + # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil] + # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] + # @param timezone [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customer] # @@ -204,163 +67,27 @@ def create(params) # `additional_emails` of an existing customer. Other fields on a customer are # currently immutable. # - # @param customer_id [String] + # @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) # - # @param params [Orb::Models::CustomerUpdateParams, Hash{Symbol=>Object}] . - # - # @option params [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil] :accounting_sync_configuration - # - # @option params [Array, nil] :additional_emails Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. - # - # @option params [Boolean, nil] :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. - # - # @option params [Orb::Models::CustomerUpdateParams::BillingAddress, nil] :billing_address - # - # @option params [String, nil] :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. - # - # @option params [String, nil] :email A valid customer email, to be used for invoicing and notifications. - # - # @option params [Boolean, nil] :email_delivery - # - # @option params [String, nil] :external_customer_id The external customer ID. This can only be set if empty and the customer has no - # past or current subscriptions. - # - # @option params [Orb::Models::CustomerUpdateParams::Hierarchy, nil] :hierarchy The hierarchical relationships for this customer. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [String, nil] :name The full name of the customer - # - # @option params [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] :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. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. - # - # @option params [String, nil] :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. - # - # @option params [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil] :reporting_configuration - # - # @option params [Orb::Models::CustomerUpdateParams::ShippingAddress, nil] :shipping_address - # - # @option params [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil] :tax_configuration - # - # @option params [Orb::Models::CustomerUpdateParams::TaxID, nil] :tax_id Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. - # - # ### Supported Tax ID Countries and Types - # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil] + # @param additional_emails [Array, nil] + # @param auto_collection [Boolean, nil] + # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil] + # @param currency [String, nil] + # @param email [String, nil] + # @param email_delivery [Boolean, nil] + # @param external_customer_id [String, nil] + # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param name [String, nil] + # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] + # @param payment_provider_id [String, nil] + # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil] + # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil] + # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateParams::TaxConfiguration::NewTaxJarConfiguration, nil] + # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customer] # @@ -383,22 +110,15 @@ def update(customer_id, params = {}) # # See [Customer](/core-concepts##customer) for an overview of the customer model. # - # @param params [Orb::Models::CustomerListParams, Hash{Symbol=>Object}] . - # - # @option params [Time, nil] :created_at_gt - # - # @option params [Time, nil] :created_at_gte - # - # @option params [Time, nil] :created_at_lt - # - # @option params [Time, nil] :created_at_lte - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param created_at_gt [Time, nil] + # @param created_at_gte [Time, nil] + # @param created_at_lt [Time, nil] + # @param created_at_lte [Time, nil] + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -431,11 +151,10 @@ def list(params = {}) # # On successful processing, this returns an empty dictionary (`{}`) in the API. # - # @param customer_id [String] - # - # @param params [Orb::Models::CustomerDeleteParams, Hash{Symbol=>Object}] . + # @overload delete(customer_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # @@ -456,11 +175,10 @@ def delete(customer_id, params = {}) # See the [Customer resource](/core-concepts#customer) for a full discussion of # the Customer model. # - # @param customer_id [String] - # - # @param params [Orb::Models::CustomerFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(customer_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customer] # @@ -480,11 +198,10 @@ def fetch(customer_id, params = {}) # Note that the resource and semantics of this endpoint exactly mirror # [Get Customer](fetch-customer). # - # @param external_customer_id [String] - # - # @param params [Orb::Models::CustomerFetchByExternalIDParams, Hash{Symbol=>Object}] . + # @overload fetch_by_external_id(external_customer_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_customer_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customer] # @@ -505,11 +222,10 @@ def fetch_by_external_id(external_customer_id, params = {}) # # **Note**: This functionality is currently only available for Stripe. # - # @param external_customer_id [String] - # - # @param params [Orb::Models::CustomerSyncPaymentMethodsFromGatewayParams, Hash{Symbol=>Object}] . + # @overload sync_payment_methods_from_gateway(external_customer_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_customer_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # @@ -533,11 +249,10 @@ def sync_payment_methods_from_gateway(external_customer_id, params = {}) # # **Note**: This functionality is currently only available for Stripe. # - # @param customer_id [String] - # - # @param params [Orb::Models::CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams, Hash{Symbol=>Object}] . + # @overload sync_payment_methods_from_gateway_by_external_customer_id(customer_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # @@ -556,163 +271,27 @@ def sync_payment_methods_from_gateway_by_external_customer_id(customer_id, param # resource and semantics of this endpoint exactly mirror # [Update Customer](update-customer). # - # @param id [String] + # @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {}) # - # @param params [Orb::Models::CustomerUpdateByExternalIDParams, Hash{Symbol=>Object}] . - # - # @option params [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil] :accounting_sync_configuration - # - # @option params [Array, nil] :additional_emails Additional email addresses for this customer. If populated, these email - # addresses will be CC'd for customer communications. - # - # @option params [Boolean, nil] :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. - # - # @option params [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil] :billing_address - # - # @option params [String, nil] :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. - # - # @option params [String, nil] :email A valid customer email, to be used for invoicing and notifications. - # - # @option params [Boolean, nil] :email_delivery - # - # @option params [String, nil] :external_customer_id The external customer ID. This can only be set if empty and the customer has no - # past or current subscriptions. - # - # @option params [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] :hierarchy The hierarchical relationships for this customer. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [String, nil] :name The full name of the customer - # - # @option params [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] :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. - # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, - # `bill.com`, `netsuite`), any product mappings must first be configured with - # the Orb team. - # - # @option params [String, nil] :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. - # - # @option params [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil] :reporting_configuration - # - # @option params [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil] :shipping_address - # - # @option params [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil] :tax_configuration - # - # @option params [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] :tax_id Tax IDs are commonly required to be displayed on customer invoices, which are - # added to the headers of invoices. - # - # ### Supported Tax ID Countries and Types - # - # | Country | Type | Description | - # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- | - # | Andorra | `ad_nrt` | Andorran NRT Number | - # | Argentina | `ar_cuit` | Argentinian Tax ID Number | - # | Australia | `au_abn` | Australian Business Number (AU ABN) | - # | Australia | `au_arn` | Australian Taxation Office Reference Number | - # | Austria | `eu_vat` | European VAT Number | - # | Bahrain | `bh_vat` | Bahraini VAT Number | - # | Belgium | `eu_vat` | European VAT Number | - # | Bolivia | `bo_tin` | Bolivian Tax ID | - # | Brazil | `br_cnpj` | Brazilian CNPJ Number | - # | Brazil | `br_cpf` | Brazilian CPF Number | - # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | - # | Bulgaria | `eu_vat` | European VAT Number | - # | Canada | `ca_bn` | Canadian BN | - # | Canada | `ca_gst_hst` | Canadian GST/HST Number | - # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | - # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | - # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | - # | Canada | `ca_qst` | Canadian QST Number (Québec) | - # | Chile | `cl_tin` | Chilean TIN | - # | China | `cn_tin` | Chinese Tax ID | - # | Colombia | `co_nit` | Colombian NIT Number | - # | Costa Rica | `cr_tin` | Costa Rican Tax ID | - # | Croatia | `eu_vat` | European VAT Number | - # | Cyprus | `eu_vat` | European VAT Number | - # | Czech Republic | `eu_vat` | European VAT Number | - # | Denmark | `eu_vat` | European VAT Number | - # | Dominican Republic | `do_rcn` | Dominican RCN Number | - # | Ecuador | `ec_ruc` | Ecuadorian RUC Number | - # | Egypt | `eg_tin` | Egyptian Tax Identification Number | - # | El Salvador | `sv_nit` | El Salvadorian NIT Number | - # | Estonia | `eu_vat` | European VAT Number | - # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | - # | Finland | `eu_vat` | European VAT Number | - # | France | `eu_vat` | European VAT Number | - # | Georgia | `ge_vat` | Georgian VAT | - # | Germany | `eu_vat` | European VAT Number | - # | Greece | `eu_vat` | European VAT Number | - # | Hong Kong | `hk_br` | Hong Kong BR Number | - # | Hungary | `eu_vat` | European VAT Number | - # | Hungary | `hu_tin` | Hungary Tax Number (adószám) | - # | Iceland | `is_vat` | Icelandic VAT | - # | India | `in_gst` | Indian GST Number | - # | Indonesia | `id_npwp` | Indonesian NPWP Number | - # | Ireland | `eu_vat` | European VAT Number | - # | Israel | `il_vat` | Israel VAT | - # | Italy | `eu_vat` | European VAT Number | - # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) | - # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) | - # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) | - # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | - # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | - # | Latvia | `eu_vat` | European VAT Number | - # | Liechtenstein | `li_uid` | Liechtensteinian UID Number | - # | Lithuania | `eu_vat` | European VAT Number | - # | Luxembourg | `eu_vat` | European VAT Number | - # | Malaysia | `my_frp` | Malaysian FRP Number | - # | Malaysia | `my_itn` | Malaysian ITN | - # | Malaysia | `my_sst` | Malaysian SST Number | - # | Malta | `eu_vat ` | European VAT Number | - # | Mexico | `mx_rfc` | Mexican RFC Number | - # | Netherlands | `eu_vat` | European VAT Number | - # | New Zealand | `nz_gst` | New Zealand GST Number | - # | Nigeria | `ng_tin` | Nigerian Tax Identification Number | - # | Norway | `no_vat` | Norwegian VAT Number | - # | Norway | `no_voec` | Norwegian VAT on e-commerce Number | - # | Oman | `om_vat` | Omani VAT Number | - # | Peru | `pe_ruc` | Peruvian RUC Number | - # | Philippines | `ph_tin ` | Philippines Tax Identification Number | - # | Poland | `eu_vat` | European VAT Number | - # | Portugal | `eu_vat` | European VAT Number | - # | Romania | `eu_vat` | European VAT Number | - # | Romania | `ro_tin` | Romanian Tax ID Number | - # | Russia | `ru_inn` | Russian INN | - # | Russia | `ru_kpp` | Russian KPP | - # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | - # | Serbia | `rs_pib` | Serbian PIB Number | - # | Singapore | `sg_gst` | Singaporean GST | - # | Singapore | `sg_uen` | Singaporean UEN | - # | Slovakia | `eu_vat` | European VAT Number | - # | Slovenia | `eu_vat` | European VAT Number | - # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | - # | South Africa | `za_vat` | South African VAT Number | - # | South Korea | `kr_brn` | Korean BRN | - # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | - # | Spain | `eu_vat` | European VAT Number | - # | Sweden | `eu_vat` | European VAT Number | - # | Switzerland | `ch_vat` | Switzerland VAT Number | - # | Taiwan | `tw_vat` | Taiwanese VAT | - # | Thailand | `th_vat` | Thai VAT | - # | Turkey | `tr_tin` | Turkish Tax Identification Number | - # | Ukraine | `ua_vat` | Ukrainian VAT | - # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | - # | United Kingdom | `eu_vat` | Northern Ireland VAT Number | - # | United Kingdom | `gb_vat` | United Kingdom VAT Number | - # | United States | `us_ein` | United States EIN | - # | Uruguay | `uy_ruc` | Uruguayan RUC Number | - # | Venezuela | `ve_rif` | Venezuelan RIF Number | - # | Vietnam | `vn_tin` | Vietnamese Tax ID Number | - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param id [String] + # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil] + # @param additional_emails [Array, nil] + # @param auto_collection [Boolean, nil] + # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil] + # @param currency [String, nil] + # @param email [String, nil] + # @param email_delivery [Boolean, nil] + # @param external_customer_id [String, nil] + # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param name [String, nil] + # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] + # @param payment_provider_id [String, nil] + # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil] + # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil] + # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil] + # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customer] # diff --git a/lib/orb/resources/customers/balance_transactions.rb b/lib/orb/resources/customers/balance_transactions.rb index 32333d7d..892e4f1c 100644 --- a/lib/orb/resources/customers/balance_transactions.rb +++ b/lib/orb/resources/customers/balance_transactions.rb @@ -7,17 +7,13 @@ class BalanceTransactions # Creates an immutable balance transaction that updates the customer's balance and # returns back the newly created transaction. # - # @param customer_id [String] - # - # @param params [Orb::Models::Customers::BalanceTransactionCreateParams, Hash{Symbol=>Object}] . - # - # @option params [String] :amount - # - # @option params [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type] :type + # @overload create(customer_id, amount:, type:, description: nil, request_options: {}) # - # @option params [String, nil] :description An optional description that can be specified around this entry. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param amount [String] + # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type] + # @param description [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::BalanceTransactionCreateResponse] # @@ -62,24 +58,16 @@ def create(customer_id, params) # such as Stripe is used, the balance will be applied to the invoice before # forwarding payment to the gateway. # - # @param customer_id [String] - # - # @param params [Orb::Models::Customers::BalanceTransactionListParams, Hash{Symbol=>Object}] . + # @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: {}) # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Time, nil] :operation_time_gt - # - # @option params [Time, nil] :operation_time_gte - # - # @option params [Time, nil] :operation_time_lt - # - # @option params [Time, nil] :operation_time_lte - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param cursor [String, nil] + # @param limit [Integer] + # @param operation_time_gt [Time, nil] + # @param operation_time_gte [Time, nil] + # @param operation_time_lt [Time, nil] + # @param operation_time_lte [Time, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # diff --git a/lib/orb/resources/customers/costs.rb b/lib/orb/resources/customers/costs.rb index db48144e..cf4ec619 100644 --- a/lib/orb/resources/customers/costs.rb +++ b/lib/orb/resources/customers/costs.rb @@ -122,22 +122,14 @@ class Costs # `secondary_grouping_key` based on the matrix price definition, for each # `grouping_value` and `secondary_grouping_value` available. # - # @param customer_id [String] - # - # @param params [Orb::Models::Customers::CostListParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :currency The currency or custom pricing unit to use. - # - # @option params [Time, nil] :timeframe_end Costs returned are exclusive of `timeframe_end`. + # @overload list(customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # - # @option params [Time, nil] :timeframe_start Costs returned are inclusive of `timeframe_start`. - # - # @option params [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param currency [String, nil] + # @param timeframe_end [Time, nil] + # @param timeframe_start [Time, nil] + # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::CostListResponse] # @@ -271,22 +263,14 @@ def list(customer_id, params = {}) # `secondary_grouping_key` based on the matrix price definition, for each # `grouping_value` and `secondary_grouping_value` available. # - # @param external_customer_id [String] - # - # @param params [Orb::Models::Customers::CostListByExternalIDParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :currency The currency or custom pricing unit to use. - # - # @option params [Time, nil] :timeframe_end Costs returned are exclusive of `timeframe_end`. + # @overload list_by_external_id(external_customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # - # @option params [Time, nil] :timeframe_start Costs returned are inclusive of `timeframe_start`. - # - # @option params [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_customer_id [String] + # @param currency [String, nil] + # @param timeframe_end [Time, nil] + # @param timeframe_start [Time, nil] + # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::CostListByExternalIDResponse] # diff --git a/lib/orb/resources/customers/credits.rb b/lib/orb/resources/customers/credits.rb index c8a592c7..bf7395cc 100644 --- a/lib/orb/resources/customers/credits.rb +++ b/lib/orb/resources/customers/credits.rb @@ -18,21 +18,14 @@ class Credits # Note that `currency` defaults to credits if not specified. To use a real world # currency, set `currency` to an ISO 4217 string. # - # @param customer_id [String] - # - # @param params [Orb::Models::Customers::CreditListParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :currency The ledger currency or custom pricing unit to use. - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # @overload list(customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) # - # @option params [Boolean] :include_all_blocks If set to True, all expired and depleted blocks, as well as active block will be - # returned. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param currency [String, nil] + # @param cursor [String, nil] + # @param include_all_blocks [Boolean] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -57,21 +50,14 @@ def list(customer_id, params = {}) # Note that `currency` defaults to credits if not specified. To use a real world # currency, set `currency` to an ISO 4217 string. # - # @param external_customer_id [String] - # - # @param params [Orb::Models::Customers::CreditListByExternalIDParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :currency The ledger currency or custom pricing unit to use. - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # @overload list_by_external_id(external_customer_id, currency: nil, cursor: nil, include_all_blocks: nil, limit: nil, request_options: {}) # - # @option params [Boolean] :include_all_blocks If set to True, all expired and depleted blocks, as well as active block will be - # returned. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_customer_id [String] + # @param currency [String, nil] + # @param cursor [String, nil] + # @param include_all_blocks [Boolean] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # diff --git a/lib/orb/resources/customers/credits/ledger.rb b/lib/orb/resources/customers/credits/ledger.rb index 55fa875d..0852d0e5 100644 --- a/lib/orb/resources/customers/credits/ledger.rb +++ b/lib/orb/resources/customers/credits/ledger.rb @@ -87,32 +87,20 @@ class Ledger # 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. # - # @param customer_id [String] - # - # @param params [Orb::Models::Customers::Credits::LedgerListParams, Hash{Symbol=>Object}] . - # - # @option params [Time, nil] :created_at_gt - # - # @option params [Time, nil] :created_at_gte - # - # @option params [Time, nil] :created_at_lt - # - # @option params [Time, nil] :created_at_lte - # - # @option params [String, nil] :currency The ledger currency or custom pricing unit to use. + # @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: {}) # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil] :entry_status - # - # @option params [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil] :entry_type - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [String, nil] :minimum_amount - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param created_at_gt [Time, nil] + # @param created_at_gte [Time, nil] + # @param created_at_lt [Time, nil] + # @param created_at_lte [Time, nil] + # @param currency [String, nil] + # @param cursor [String, nil] + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil] + # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil] + # @param limit [Integer] + # @param minimum_amount [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -240,48 +228,22 @@ def list(customer_id, params = {}) # that was originally decremented from, and `amount` indicates how many credits to # return to the customer, up to the block's initial balance. # - # @param customer_id [String] - # - # @param params [Orb::Models::Customers::Credits::LedgerCreateEntryParams, Hash{Symbol=>Object}] . - # - # @option params [Float] :amount The number of credits to effect. Note that this is required for increment, - # decrement or void operations. - # - # @option params [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType] :entry_type - # - # @option params [Time, nil] :expiry_date An ISO 8601 format date that identifies the origination credit block to expire - # - # @option params [Date] :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. - # - # @option params [String] :block_id The ID of the block to reverse a decrement from. - # - # @option params [String, nil] :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. + # @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: {}) # - # @option params [String, nil] :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. - # - # @option params [Time, nil] :effective_date An ISO 8601 format date that denotes when this credit balance should become - # available for use. - # - # @option params [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] :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. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [String, nil] :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 - # - # @option params [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] :void_reason Can only be specified when `entry_type=void`. The reason for the void. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param amount [Float] + # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType] + # @param expiry_date [Time, nil] + # @param target_expiry_date [Date] + # @param block_id [String] + # @param currency [String, nil] + # @param description [String, nil] + # @param effective_date [Time, nil] + # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param per_unit_cost_basis [String, nil] + # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry] # @@ -408,48 +370,22 @@ def create_entry(customer_id, params) # that was originally decremented from, and `amount` indicates how many credits to # return to the customer, up to the block's initial balance. # - # @param external_customer_id [String] - # - # @param params [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams, Hash{Symbol=>Object}] . - # - # @option params [Float] :amount The number of credits to effect. Note that this is required for increment, - # decrement or void operations. - # - # @option params [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType] :entry_type - # - # @option params [Time, nil] :expiry_date An ISO 8601 format date that identifies the origination credit block to expire - # - # @option params [Date] :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. - # - # @option params [String] :block_id The ID of the block to reverse a decrement from. - # - # @option params [String, nil] :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. - # - # @option params [String, nil] :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. - # - # @option params [Time, nil] :effective_date An ISO 8601 format date that denotes when this credit balance should become - # available for use. - # - # @option params [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] :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. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [String, nil] :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 - # - # @option params [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] :void_reason Can only be specified when `entry_type=void`. The reason for the void. + # @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: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_customer_id [String] + # @param amount [Float] + # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType] + # @param expiry_date [Time, nil] + # @param target_expiry_date [Date] + # @param block_id [String] + # @param currency [String, nil] + # @param description [String, nil] + # @param effective_date [Time, nil] + # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param per_unit_cost_basis [String, nil] + # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry] # @@ -548,32 +484,20 @@ def create_entry_by_external_id(external_customer_id, params) # 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. # - # @param external_customer_id [String] - # - # @param params [Orb::Models::Customers::Credits::LedgerListByExternalIDParams, Hash{Symbol=>Object}] . - # - # @option params [Time, nil] :created_at_gt - # - # @option params [Time, nil] :created_at_gte - # - # @option params [Time, nil] :created_at_lt - # - # @option params [Time, nil] :created_at_lte + # @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: {}) # - # @option params [String, nil] :currency The ledger currency or custom pricing unit to use. - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil] :entry_status - # - # @option params [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil] :entry_type - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [String, nil] :minimum_amount - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_customer_id [String] + # @param created_at_gt [Time, nil] + # @param created_at_gte [Time, nil] + # @param created_at_lt [Time, nil] + # @param created_at_lte [Time, nil] + # @param currency [String, nil] + # @param cursor [String, nil] + # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil] + # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil] + # @param limit [Integer] + # @param minimum_amount [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # diff --git a/lib/orb/resources/customers/credits/top_ups.rb b/lib/orb/resources/customers/credits/top_ups.rb index 954bdafb..f060fddf 100644 --- a/lib/orb/resources/customers/credits/top_ups.rb +++ b/lib/orb/resources/customers/credits/top_ups.rb @@ -13,31 +13,18 @@ class TopUps # If a top-up already exists for this customer in the same currency, the existing # top-up will be replaced. # - # @param customer_id [String] - # - # @param params [Orb::Models::Customers::Credits::TopUpCreateParams, Hash{Symbol=>Object}] . - # - # @option params [String] :amount The amount to increment when the threshold is reached. - # - # @option params [String] :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. - # - # @option params [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] :invoice_settings Settings for invoices generated by triggered top-ups. - # - # @option params [String] :per_unit_cost_basis How much, in the customer's currency, to charge for each unit. + # @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: {}) # - # @option params [String] :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. - # - # @option params [Time, nil] :active_from The date from which the top-up is active. If unspecified, the top-up is active - # immediately. - # - # @option params [Integer, nil] :expires_after The number of days or months after which the top-up expires. If unspecified, it - # does not expire. - # - # @option params [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] :expires_after_unit The unit of expires_after. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param amount [String] + # @param currency [String] + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] + # @param per_unit_cost_basis [String] + # @param threshold [String] + # @param active_from [Time, nil] + # @param expires_after [Integer, nil] + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::Credits::TopUpCreateResponse] # @@ -55,16 +42,12 @@ def create(customer_id, params) # List top-ups # - # @param customer_id [String] - # - # @param params [Orb::Models::Customers::Credits::TopUpListParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # @overload list(customer_id, cursor: nil, limit: nil, request_options: {}) # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param customer_id [String] + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -84,13 +67,11 @@ def list(customer_id, params = {}) # This deactivates the top-up and voids any invoices associated with pending # credit blocks purchased through the top-up. # - # @param top_up_id [String] - # - # @param params [Orb::Models::Customers::Credits::TopUpDeleteParams, Hash{Symbol=>Object}] . - # - # @option params [String] :customer_id + # @overload delete(top_up_id, customer_id:, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param top_up_id [String] + # @param customer_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # @@ -117,31 +98,18 @@ def delete(top_up_id, params) # If a top-up already exists for this customer in the same currency, the existing # top-up will be replaced. # - # @param external_customer_id [String] - # - # @param params [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams, Hash{Symbol=>Object}] . - # - # @option params [String] :amount The amount to increment when the threshold is reached. - # - # @option params [String] :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. - # - # @option params [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] :invoice_settings Settings for invoices generated by triggered top-ups. - # - # @option params [String] :per_unit_cost_basis How much, in the customer's currency, to charge for each unit. + # @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: {}) # - # @option params [String] :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. - # - # @option params [Time, nil] :active_from The date from which the top-up is active. If unspecified, the top-up is active - # immediately. - # - # @option params [Integer, nil] :expires_after The number of days or months after which the top-up expires. If unspecified, it - # does not expire. - # - # @option params [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] :expires_after_unit The unit of expires_after. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_customer_id [String] + # @param amount [String] + # @param currency [String] + # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] + # @param per_unit_cost_basis [String] + # @param threshold [String] + # @param active_from [Time, nil] + # @param expires_after [Integer, nil] + # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse] # @@ -160,13 +128,11 @@ def create_by_external_id(external_customer_id, params) # This deactivates the top-up and voids any invoices associated with pending # credit blocks purchased through the top-up. # - # @param top_up_id [String] - # - # @param params [Orb::Models::Customers::Credits::TopUpDeleteByExternalIDParams, Hash{Symbol=>Object}] . - # - # @option params [String] :external_customer_id + # @overload delete_by_external_id(top_up_id, external_customer_id:, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param top_up_id [String] + # @param external_customer_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # @@ -191,16 +157,12 @@ def delete_by_external_id(top_up_id, params) # List top-ups by external ID # - # @param external_customer_id [String] - # - # @param params [Orb::Models::Customers::Credits::TopUpListByExternalIDParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # @overload list_by_external_id(external_customer_id, cursor: nil, limit: nil, request_options: {}) # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_customer_id [String] + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # diff --git a/lib/orb/resources/dimensional_price_groups.rb b/lib/orb/resources/dimensional_price_groups.rb index 1436e8b3..42926507 100644 --- a/lib/orb/resources/dimensional_price_groups.rb +++ b/lib/orb/resources/dimensional_price_groups.rb @@ -15,21 +15,14 @@ class DimensionalPriceGroups # 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. # - # @param params [Orb::Models::DimensionalPriceGroupCreateParams, Hash{Symbol=>Object}] . + # @overload create(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {}) # - # @option params [String] :billable_metric_id - # - # @option params [Array] :dimensions The set of keys (in order) used to disambiguate prices in the group. - # - # @option params [String] :name - # - # @option params [String, nil] :external_dimensional_price_group_id - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param billable_metric_id [String] + # @param dimensions [Array] + # @param name [String] + # @param external_dimensional_price_group_id [String, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::DimensionalPriceGroup] # @@ -47,11 +40,10 @@ def create(params) # Fetch dimensional price group # - # @param dimensional_price_group_id [String] - # - # @param params [Orb::Models::DimensionalPriceGroupRetrieveParams, Hash{Symbol=>Object}] . + # @overload retrieve(dimensional_price_group_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param dimensional_price_group_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::DimensionalPriceGroup] # @@ -67,14 +59,11 @@ def retrieve(dimensional_price_group_id, params = {}) # List dimensional price groups # - # @param params [Orb::Models::DimensionalPriceGroupListParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. + # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # diff --git a/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb b/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb index 29ad355f..e3dd1c62 100644 --- a/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +++ b/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb @@ -6,11 +6,10 @@ class DimensionalPriceGroups class ExternalDimensionalPriceGroupID # Fetch dimensional price group by external ID # - # @param external_dimensional_price_group_id [String] - # - # @param params [Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDRetrieveParams, Hash{Symbol=>Object}] . + # @overload retrieve(external_dimensional_price_group_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_dimensional_price_group_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::DimensionalPriceGroup] # diff --git a/lib/orb/resources/events.rb b/lib/orb/resources/events.rb index 405b6811..75a07c80 100644 --- a/lib/orb/resources/events.rb +++ b/lib/orb/resources/events.rb @@ -55,25 +55,15 @@ class Events # 100 day period. For higher volume updates, consider using the # [event backfill](create-backfill) endpoint. # - # @param event_id [String] - # - # @param params [Orb::Models::EventUpdateParams, Hash{Symbol=>Object}] . - # - # @option params [String] :event_name A name to meaningfully identify the action or event type. - # - # @option params [Object] :properties A dictionary of custom properties. Values in this dictionary must be numeric, - # boolean, or strings. Nested dictionaries are disallowed. - # - # @option params [Time] :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. + # @overload update(event_id, event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {}) # - # @option params [String, nil] :customer_id The Orb Customer identifier - # - # @option params [String, nil] :external_customer_id An alias for the Orb customer, whose mapping is specified when creating the - # customer - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param event_id [String] + # @param event_name [String] + # @param properties [Object] + # @param timestamp [Time] + # @param customer_id [String, nil] + # @param external_customer_id [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::EventUpdateResponse] # @@ -130,11 +120,10 @@ def update(event_id, params) # a 100 day period. For higher volume updates, consider using the # [event backfill](create-backfill) endpoint. # - # @param event_id [String] + # @overload deprecate(event_id, request_options: {}) # - # @param params [Orb::Models::EventDeprecateParams, Hash{Symbol=>Object}] . - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param event_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::EventDeprecateResponse] # @@ -353,17 +342,12 @@ def deprecate(event_id, params = {}) # } # ``` # - # @param params [Orb::Models::EventIngestParams, Hash{Symbol=>Object}] . - # - # @option params [Array] :events Body param: - # - # @option params [String, nil] :backfill_id Query param: If this ingestion request is part of a backfill, this parameter - # ties the ingested events to the backfill + # @overload ingest(events:, backfill_id: nil, debug: nil, request_options: {}) # - # @option params [Boolean] :debug Query param: Flag to enable additional debug information in the endpoint - # response - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param events [Array] + # @param backfill_id [String, nil] + # @param debug [Boolean] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::EventIngestResponse] # @@ -397,20 +381,12 @@ def ingest(params) # By default, Orb will not throw a `404` if no events matched, Orb will return an # empty array for `data` instead. # - # @param params [Orb::Models::EventSearchParams, Hash{Symbol=>Object}] . - # - # @option params [Array] :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. - # - # @option params [Time, nil] :timeframe_end The end of the timeframe, exclusive, in which to search events. If not - # specified, the current time is used. - # - # @option params [Time, nil] :timeframe_start The start of the timeframe, inclusive, in which to search events. If not - # specified, the one week ago is used. + # @overload search(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param event_ids [Array] + # @param timeframe_end [Time, nil] + # @param timeframe_start [Time, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::EventSearchResponse] # diff --git a/lib/orb/resources/events/backfills.rb b/lib/orb/resources/events/backfills.rb index a804e118..2d0680ae 100644 --- a/lib/orb/resources/events/backfills.rb +++ b/lib/orb/resources/events/backfills.rb @@ -42,34 +42,16 @@ class Backfills # expressiveness of computed properties allows you to deprecate existing events # based on both a period of time and specific property values. # - # @param params [Orb::Models::Events::BackfillCreateParams, Hash{Symbol=>Object}] . + # @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: {}) # - # @option params [Time] :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. - # - # @option params [Time] :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. - # - # @option params [Time, nil] :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. - # - # @option params [String, nil] :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. - # - # @option params [String, nil] :deprecation_filter A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the set of events to deprecate - # - # @option params [String, nil] :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. - # - # @option params [Boolean] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param timeframe_end [Time] + # @param timeframe_start [Time] + # @param close_time [Time, nil] + # @param customer_id [String, nil] + # @param deprecation_filter [String, nil] + # @param external_customer_id [String, nil] + # @param replace_existing_events [Boolean] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Events::BackfillCreateResponse] # @@ -93,14 +75,11 @@ def create(params) # retrieve the next page of results if they exist. More information about # pagination can be found in the [Pagination-metadata schema](pagination). # - # @param params [Orb::Models::Events::BackfillListParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. + # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -122,11 +101,10 @@ def list(params = {}) # and usage graphs. Once all of the updates are complete, the backfill's status # will transition to `reflected`. # - # @param backfill_id [String] - # - # @param params [Orb::Models::Events::BackfillCloseParams, Hash{Symbol=>Object}] . + # @overload close(backfill_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param backfill_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Events::BackfillCloseResponse] # @@ -142,11 +120,10 @@ def close(backfill_id, params = {}) # This endpoint is used to fetch a backfill given an identifier. # - # @param backfill_id [String] - # - # @param params [Orb::Models::Events::BackfillFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(backfill_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param backfill_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Events::BackfillFetchResponse] # @@ -168,11 +145,10 @@ def fetch(backfill_id, params = {}) # 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`. # - # @param backfill_id [String] - # - # @param params [Orb::Models::Events::BackfillRevertParams, Hash{Symbol=>Object}] . + # @overload revert(backfill_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param backfill_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Events::BackfillRevertResponse] # diff --git a/lib/orb/resources/events/volume.rb b/lib/orb/resources/events/volume.rb index 13e84158..17d18350 100644 --- a/lib/orb/resources/events/volume.rb +++ b/lib/orb/resources/events/volume.rb @@ -18,24 +18,13 @@ class Volume # timestamp is passed in for either start or end time, the response includes the # hours the timestamp falls in. # - # @param params [Orb::Models::Events::VolumeListParams, Hash{Symbol=>Object}] . + # @overload list(timeframe_start:, cursor: nil, limit: nil, timeframe_end: nil, request_options: {}) # - # @option params [Time] :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. - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Time] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param timeframe_start [Time] + # @param cursor [String, nil] + # @param limit [Integer] + # @param timeframe_end [Time] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Events::EventVolumes] # diff --git a/lib/orb/resources/invoice_line_items.rb b/lib/orb/resources/invoice_line_items.rb index 11e007a6..afacdf80 100644 --- a/lib/orb/resources/invoice_line_items.rb +++ b/lib/orb/resources/invoice_line_items.rb @@ -6,22 +6,15 @@ 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. # - # @param params [Orb::Models::InvoiceLineItemCreateParams, Hash{Symbol=>Object}] . - # - # @option params [String] :amount The total amount in the invoice's currency to add to the line item. - # - # @option params [Date] :end_date A date string to specify the line item's end date in the customer's timezone. - # - # @option params [String] :invoice_id The id of the Invoice to add this line item. - # - # @option params [String] :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. - # - # @option params [Float] :quantity The number of units on the line item - # - # @option params [Date] :start_date A date string to specify the line item's start date in the customer's timezone. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @overload create(amount:, end_date:, invoice_id:, name:, quantity:, start_date:, request_options: {}) + # + # @param amount [String] + # @param end_date [Date] + # @param invoice_id [String] + # @param name [String] + # @param quantity [Float] + # @param start_date [Date] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::InvoiceLineItemCreateResponse] # diff --git a/lib/orb/resources/invoices.rb b/lib/orb/resources/invoices.rb index 33b68054..0befd600 100644 --- a/lib/orb/resources/invoices.rb +++ b/lib/orb/resources/invoices.rb @@ -5,39 +5,19 @@ module Resources class Invoices # This endpoint is used to create a one-off invoice for a customer. # - # @param params [Orb::Models::InvoiceCreateParams, Hash{Symbol=>Object}] . - # - # @option params [String] :currency An ISO 4217 currency string. Must be the same as the customer's currency if it - # is set. - # - # @option params [Time] :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. - # - # @option params [Array] :line_items - # - # @option params [Integer] :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. - # - # @option params [String, nil] :customer_id The id of the `Customer` to create this invoice for. One of `customer_id` and - # `external_customer_id` are required. - # - # @option params [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] :discount An optional discount to attach to the invoice. - # - # @option params [String, nil] :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. - # - # @option params [String, nil] :memo An optional memo to attach to the invoice. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Boolean] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @overload create(currency:, invoice_date:, line_items:, net_terms:, customer_id: nil, discount: nil, external_customer_id: nil, memo: nil, metadata: nil, will_auto_issue: nil, request_options: {}) + # + # @param currency [String] + # @param invoice_date [Time] + # @param line_items [Array] + # @param net_terms [Integer] + # @param customer_id [String, nil] + # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] + # @param external_customer_id [String, nil] + # @param memo [String, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param will_auto_issue [Boolean] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] # @@ -59,15 +39,11 @@ def create(params) # # `metadata` can be modified regardless of invoice state. # - # @param invoice_id [String] - # - # @param params [Orb::Models::InvoiceUpdateParams, Hash{Symbol=>Object}] . - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. + # @overload update(invoice_id, metadata: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param invoice_id [String] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] # @@ -97,51 +73,28 @@ def update(invoice_id, params = {}) # values for each draft invoice, which may not always be up-to-date since Orb # regularly refreshes invoices asynchronously. # - # @param params [Orb::Models::InvoiceListParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :amount - # - # @option params [String, nil] :amount_gt - # - # @option params [String, nil] :amount_lt - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [String, nil] :customer_id - # - # @option params [Symbol, Orb::Models::InvoiceListParams::DateType, nil] :date_type - # - # @option params [Date, nil] :due_date - # - # @option params [String, nil] :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. - # - # @option params [Date, nil] :due_date_gt - # - # @option params [Date, nil] :due_date_lt - # - # @option params [String, nil] :external_customer_id - # - # @option params [Time, nil] :invoice_date_gt - # - # @option params [Time, nil] :invoice_date_gte - # - # @option params [Time, nil] :invoice_date_lt - # - # @option params [Time, nil] :invoice_date_lte - # - # @option params [Boolean, nil] :is_recurring - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Array, nil] :status - # - # @option params [String, nil] :subscription_id - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @overload list(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {}) + # + # @param amount [String, nil] + # @param amount_gt [String, nil] + # @param amount_lt [String, nil] + # @param cursor [String, nil] + # @param customer_id [String, nil] + # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil] + # @param due_date [Date, nil] + # @param due_date_window [String, nil] + # @param due_date_gt [Date, nil] + # @param due_date_lt [Date, nil] + # @param external_customer_id [String, nil] + # @param invoice_date_gt [Time, nil] + # @param invoice_date_gte [Time, nil] + # @param invoice_date_lt [Time, nil] + # @param invoice_date_lte [Time, nil] + # @param is_recurring [Boolean, nil] + # @param limit [Integer] + # @param status [Array, nil] + # @param subscription_id [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -161,11 +114,10 @@ def list(params = {}) # This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an # identifier. # - # @param invoice_id [String] - # - # @param params [Orb::Models::InvoiceFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(invoice_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param invoice_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] # @@ -183,11 +135,10 @@ def fetch(invoice_id, params = {}) # [invoice](/core-concepts#invoice) for the current billing period given a # subscription. # - # @param params [Orb::Models::InvoiceFetchUpcomingParams, Hash{Symbol=>Object}] . - # - # @option params [String] :subscription_id + # @overload fetch_upcoming(subscription_id:, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::InvoiceFetchUpcomingResponse] # @@ -210,17 +161,11 @@ def fetch_upcoming(params) # sending emails, auto-collecting payment, syncing the invoice to external # providers, etc). # - # @param invoice_id [String] - # - # @param params [Orb::Models::InvoiceIssueParams, Hash{Symbol=>Object}] . - # - # @option params [Boolean] :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. + # @overload issue(invoice_id, synchronous: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param invoice_id [String] + # @param synchronous [Boolean] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] # @@ -239,17 +184,13 @@ def issue(invoice_id, params = {}) # 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. # - # @param invoice_id [String] - # - # @param params [Orb::Models::InvoiceMarkPaidParams, Hash{Symbol=>Object}] . - # - # @option params [Date] :payment_received_date A date string to specify the date of the payment. + # @overload mark_paid(invoice_id, payment_received_date:, external_id: nil, notes: nil, request_options: {}) # - # @option params [String, nil] :external_id An optional external ID to associate with the payment. - # - # @option params [String, nil] :notes An optional note to associate with the payment. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param invoice_id [String] + # @param payment_received_date [Date] + # @param external_id [String, nil] + # @param notes [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] # @@ -268,11 +209,10 @@ def mark_paid(invoice_id, params) # 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". # - # @param invoice_id [String] - # - # @param params [Orb::Models::InvoicePayParams, Hash{Symbol=>Object}] . + # @overload pay(invoice_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param invoice_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] # @@ -298,11 +238,10 @@ def pay(invoice_id, params = {}) # paid, the credit block will be voided. If the invoice was created due to a # top-up, the top-up will be disabled. # - # @param invoice_id [String] - # - # @param params [Orb::Models::InvoiceVoidParams, Hash{Symbol=>Object}] . + # @overload void(invoice_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param invoice_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Invoice] # diff --git a/lib/orb/resources/items.rb b/lib/orb/resources/items.rb index f6cda68f..bac9e9a5 100644 --- a/lib/orb/resources/items.rb +++ b/lib/orb/resources/items.rb @@ -5,11 +5,10 @@ module Resources class Items # This endpoint is used to create an [Item](/core-concepts#item). # - # @param params [Orb::Models::ItemCreateParams, Hash{Symbol=>Object}] . + # @overload create(name:, request_options: {}) # - # @option params [String] :name The name of the item. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param name [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Item] # @@ -21,15 +20,12 @@ def create(params) # This endpoint can be used to update properties on the Item. # - # @param item_id [String] - # - # @param params [Orb::Models::ItemUpdateParams, Hash{Symbol=>Object}] . + # @overload update(item_id, external_connections: nil, name: nil, request_options: {}) # - # @option params [Array, nil] :external_connections - # - # @option params [String, nil] :name - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param item_id [String] + # @param external_connections [Array, nil] + # @param name [String, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Item] # @@ -48,14 +44,11 @@ def update(item_id, params = {}) # This endpoint returns a list of all Items, ordered in descending order by # creation time. # - # @param params [Orb::Models::ItemListParams, Hash{Symbol=>Object}] . + # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -74,11 +67,10 @@ def list(params = {}) # This endpoint returns an item identified by its item_id. # - # @param item_id [String] + # @overload fetch(item_id, request_options: {}) # - # @param params [Orb::Models::ItemFetchParams, Hash{Symbol=>Object}] . - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param item_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Item] # diff --git a/lib/orb/resources/metrics.rb b/lib/orb/resources/metrics.rb index 62d2dc30..ac06701c 100644 --- a/lib/orb/resources/metrics.rb +++ b/lib/orb/resources/metrics.rb @@ -7,21 +7,14 @@ class Metrics # string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a # description of constructing SQL queries with examples. # - # @param params [Orb::Models::MetricCreateParams, Hash{Symbol=>Object}] . + # @overload create(description:, item_id:, name:, sql:, metadata: nil, request_options: {}) # - # @option params [String, nil] :description A description of the metric. - # - # @option params [String] :item_id The id of the item - # - # @option params [String] :name The name of the metric. - # - # @option params [String] :sql A sql string defining the metric. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param description [String, nil] + # @param item_id [String] + # @param name [String] + # @param sql [String] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::BillableMetric] # @@ -41,15 +34,11 @@ def create(params) # pass `null` for the metadata value, it will clear any existing metadata for that # invoice. # - # @param metric_id [String] - # - # @param params [Orb::Models::MetricUpdateParams, Hash{Symbol=>Object}] . + # @overload update(metric_id, metadata: nil, request_options: {}) # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param metric_id [String] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::BillableMetric] # @@ -69,22 +58,15 @@ def update(metric_id, params = {}) # metric identifier. It returns information about the metrics including its name, # description, and item. # - # @param params [Orb::Models::MetricListParams, Hash{Symbol=>Object}] . + # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {}) # - # @option params [Time, nil] :created_at_gt - # - # @option params [Time, nil] :created_at_gte - # - # @option params [Time, nil] :created_at_lt - # - # @option params [Time, nil] :created_at_lte - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param created_at_gt [Time, nil] + # @param created_at_gte [Time, nil] + # @param created_at_lt [Time, nil] + # @param created_at_lte [Time, nil] + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -104,11 +86,10 @@ def list(params = {}) # This endpoint is used to list [metrics](/core-concepts#metric). It returns # information about the metrics including its name, description, and item. # - # @param metric_id [String] - # - # @param params [Orb::Models::MetricFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(metric_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param metric_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::BillableMetric] # diff --git a/lib/orb/resources/plans.rb b/lib/orb/resources/plans.rb index a03e2350..5ed50e2b 100644 --- a/lib/orb/resources/plans.rb +++ b/lib/orb/resources/plans.rb @@ -8,32 +8,17 @@ class Plans # This endpoint allows creation of plans including their prices. # - # @param params [Orb::Models::PlanCreateParams, Hash{Symbol=>Object}] . - # - # @option params [String] :currency An ISO 4217 currency string for invoices generated by subscriptions on this - # plan. - # - # @option params [String] :name - # - # @option params [Array] :prices Prices for this plan. If the plan has phases, this includes prices across all - # phases of the plan. - # - # @option params [String, nil] :default_invoice_memo Free-form text which is available on the invoice PDF and the Orb invoice portal. - # - # @option params [String, nil] :external_plan_id - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Integer, nil] :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. - # - # @option params [Symbol, Orb::Models::PlanCreateParams::Status] :status The status of the plan to create (either active or draft). If not specified, - # this defaults to active. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @overload create(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {}) + # + # @param currency [String] + # @param name [String] + # @param prices [Array] + # @param default_invoice_memo [String, nil] + # @param external_plan_id [String, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param net_terms [Integer, nil] + # @param status [Symbol, Orb::Models::PlanCreateParams::Status] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Plan] # @@ -48,19 +33,12 @@ def create(params) # # Other fields on a customer are currently immutable. # - # @param plan_id [String] - # - # @param params [Orb::Models::PlanUpdateParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :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. + # @overload update(plan_id, external_plan_id: nil, metadata: nil, request_options: {}) # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param plan_id [String] + # @param external_plan_id [String, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Plan] # @@ -82,24 +60,16 @@ def update(plan_id, params = {}) # [`pagination_metadata`](/api-reference/pagination), which lets the caller # retrieve the next page of results if they exist. # - # @param params [Orb::Models::PlanListParams, Hash{Symbol=>Object}] . - # - # @option params [Time, nil] :created_at_gt - # - # @option params [Time, nil] :created_at_gte - # - # @option params [Time, nil] :created_at_lt - # - # @option params [Time, nil] :created_at_lte + # @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: {}) # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Symbol, Orb::Models::PlanListParams::Status] :status The plan status to filter to ('active', 'archived', or 'draft'). - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param created_at_gt [Time, nil] + # @param created_at_gte [Time, nil] + # @param created_at_lt [Time, nil] + # @param created_at_lte [Time, nil] + # @param cursor [String, nil] + # @param limit [Integer] + # @param status [Symbol, Orb::Models::PlanListParams::Status] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -134,11 +104,10 @@ def list(params = {}) # Orb supports plan phases, also known as contract ramps. For plans with phases, # the serialized prices refer to all prices across all phases. # - # @param plan_id [String] - # - # @param params [Orb::Models::PlanFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(plan_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param plan_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Plan] # diff --git a/lib/orb/resources/plans/external_plan_id.rb b/lib/orb/resources/plans/external_plan_id.rb index 0be1b662..2fce5b4c 100644 --- a/lib/orb/resources/plans/external_plan_id.rb +++ b/lib/orb/resources/plans/external_plan_id.rb @@ -9,19 +9,12 @@ class ExternalPlanID # # Other fields on a customer are currently immutable. # - # @param other_external_plan_id [String] - # - # @param params [Orb::Models::Plans::ExternalPlanIDUpdateParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :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. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. + # @overload update(other_external_plan_id, external_plan_id: nil, metadata: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param other_external_plan_id [String] + # @param external_plan_id [String, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Plan] # @@ -54,11 +47,10 @@ def update(other_external_plan_id, params = {}) # that is present. A detailed explanation of price types can be found in the # [Price schema](/core-concepts#plan-and-price). " # - # @param external_plan_id [String] - # - # @param params [Orb::Models::Plans::ExternalPlanIDFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(external_plan_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_plan_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Plan] # diff --git a/lib/orb/resources/prices.rb b/lib/orb/resources/prices.rb index b96d58de..6667df04 100644 --- a/lib/orb/resources/prices.rb +++ b/lib/orb/resources/prices.rb @@ -17,100 +17,51 @@ class Prices # See the [Price resource](/product-catalog/price-configuration) for the # specification of different price model configurations possible in this endpoint. # - # @param params [Orb::Models::PriceCreateParams, Hash{Symbol=>Object}] . - # - # @option params [Symbol, Orb::Models::PriceCreateParams::Cadence] :cadence The cadence to bill for this price on. - # - # @option params [String] :currency An ISO 4217 currency string for which this price is billed in. - # - # @option params [String] :item_id The id of the item the price will be associated with. - # - # @option params [Symbol, Orb::Models::PriceCreateParams::ModelType] :model_type - # - # @option params [String] :name The name of the price. - # - # @option params [Orb::Models::PriceCreateParams::UnitConfig] :unit_config - # - # @option params [Orb::Models::PriceCreateParams::PackageConfig] :package_config - # - # @option params [Orb::Models::PriceCreateParams::MatrixConfig] :matrix_config - # - # @option params [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig] :matrix_with_allocation_config - # - # @option params [Orb::Models::PriceCreateParams::TieredConfig] :tiered_config - # - # @option params [Orb::Models::PriceCreateParams::TieredBpsConfig] :tiered_bps_config - # - # @option params [Orb::Models::PriceCreateParams::BpsConfig] :bps_config - # - # @option params [Orb::Models::PriceCreateParams::BulkBpsConfig] :bulk_bps_config - # - # @option params [Orb::Models::PriceCreateParams::BulkConfig] :bulk_config - # - # @option params [Hash{Symbol=>Object}] :threshold_total_amount_config - # - # @option params [Hash{Symbol=>Object}] :tiered_package_config - # - # @option params [Hash{Symbol=>Object}] :grouped_tiered_config - # - # @option params [Hash{Symbol=>Object}] :max_group_tiered_package_config - # - # @option params [Hash{Symbol=>Object}] :tiered_with_minimum_config - # - # @option params [Hash{Symbol=>Object}] :package_with_allocation_config - # - # @option params [Hash{Symbol=>Object}] :tiered_package_with_minimum_config - # - # @option params [Hash{Symbol=>Object}] :unit_with_percent_config - # - # @option params [Hash{Symbol=>Object}] :tiered_with_proration_config - # - # @option params [Hash{Symbol=>Object}] :unit_with_proration_config - # - # @option params [Hash{Symbol=>Object}] :grouped_allocation_config - # - # @option params [Hash{Symbol=>Object}] :grouped_with_prorated_minimum_config - # - # @option params [Hash{Symbol=>Object}] :grouped_with_metered_minimum_config - # - # @option params [Hash{Symbol=>Object}] :matrix_with_display_name_config - # - # @option params [Hash{Symbol=>Object}] :bulk_with_proration_config - # - # @option params [Hash{Symbol=>Object}] :grouped_tiered_package_config - # - # @option params [Hash{Symbol=>Object}] :scalable_matrix_with_unit_pricing_config - # - # @option params [Hash{Symbol=>Object}] :scalable_matrix_with_tiered_pricing_config - # - # @option params [Hash{Symbol=>Object}] :cumulative_grouped_bulk_config - # - # @option params [String, nil] :billable_metric_id The id of the billable metric for the price. Only needed if the price is - # usage-based. - # - # @option params [Boolean, nil] :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. - # - # @option params [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] :billing_cycle_configuration For custom cadence: specifies the duration of the billing period in days or - # months. - # - # @option params [Float, nil] :conversion_rate The per unit conversion rate of the price currency to the invoicing currency. - # - # @option params [String, nil] :external_price_id An alias for the price. - # - # @option params [Float, nil] :fixed_price_quantity If the Price represents a fixed cost, this represents the quantity of units - # applied. - # - # @option params [String, nil] :invoice_grouping_key The property used to group this price on an invoice - # - # @option params [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] :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. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @overload create(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {}) + # + # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence] + # @param currency [String] + # @param item_id [String] + # @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType] + # @param name [String] + # @param unit_config [Orb::Models::PriceCreateParams::UnitConfig] + # @param package_config [Orb::Models::PriceCreateParams::PackageConfig] + # @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig] + # @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig] + # @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig] + # @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig] + # @param bps_config [Orb::Models::PriceCreateParams::BpsConfig] + # @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig] + # @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig] + # @param threshold_total_amount_config [Hash{Symbol=>Object}] + # @param tiered_package_config [Hash{Symbol=>Object}] + # @param grouped_tiered_config [Hash{Symbol=>Object}] + # @param max_group_tiered_package_config [Hash{Symbol=>Object}] + # @param tiered_with_minimum_config [Hash{Symbol=>Object}] + # @param package_with_allocation_config [Hash{Symbol=>Object}] + # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}] + # @param unit_with_percent_config [Hash{Symbol=>Object}] + # @param tiered_with_proration_config [Hash{Symbol=>Object}] + # @param unit_with_proration_config [Hash{Symbol=>Object}] + # @param grouped_allocation_config [Hash{Symbol=>Object}] + # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}] + # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}] + # @param matrix_with_display_name_config [Hash{Symbol=>Object}] + # @param bulk_with_proration_config [Hash{Symbol=>Object}] + # @param grouped_tiered_package_config [Hash{Symbol=>Object}] + # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}] + # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}] + # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}] + # @param billable_metric_id [String, nil] + # @param billed_in_advance [Boolean, nil] + # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] + # @param conversion_rate [Float, nil] + # @param external_price_id [String, nil] + # @param fixed_price_quantity [Float, nil] + # @param invoice_grouping_key [String, nil] + # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] # @@ -124,15 +75,11 @@ def create(params) # pass null for the metadata value, it will clear any existing metadata for that # price. # - # @param price_id [String] - # - # @param params [Orb::Models::PriceUpdateParams, Hash{Symbol=>Object}] . - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. + # @overload update(price_id, metadata: nil, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param price_id [String] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] # @@ -151,14 +98,11 @@ def update(price_id, params = {}) # This endpoint is used to list all add-on prices created using the # [price creation endpoint](/api-reference/price/create-price). # - # @param params [Orb::Models::PriceListParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. + # @overload list(cursor: nil, limit: nil, request_options: {}) # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param cursor [String, nil] + # @param limit [Integer] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -197,27 +141,16 @@ def list(params = {}) # endpoint rather than a GET endpoint because it employs a JSON body rather than # query parameters. # - # @param price_id [String] - # - # @param params [Orb::Models::PriceEvaluateParams, Hash{Symbol=>Object}] . - # - # @option params [Time] :timeframe_end The exclusive upper bound for event timestamps - # - # @option params [Time] :timeframe_start The inclusive lower bound for event timestamps - # - # @option params [String, nil] :customer_id The ID of the customer to which this evaluation is scoped. + # @overload evaluate(price_id, timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, request_options: {}) # - # @option params [String, nil] :external_customer_id The external customer ID of the customer to which this evaluation is scoped. - # - # @option params [String, nil] :filter A boolean - # [computed property](/extensibility/advanced-metrics#computed-properties) used to - # filter the underlying billable metric - # - # @option params [Array] :grouping_keys Properties (or - # [computed properties](/extensibility/advanced-metrics#computed-properties)) used - # to group the underlying billable metric - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param price_id [String] + # @param timeframe_end [Time] + # @param timeframe_start [Time] + # @param customer_id [String, nil] + # @param external_customer_id [String, nil] + # @param filter [String, nil] + # @param grouping_keys [Array] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::PriceEvaluateResponse] # @@ -235,11 +168,10 @@ def evaluate(price_id, params) # This endpoint returns a price given an identifier. # - # @param price_id [String] - # - # @param params [Orb::Models::PriceFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(price_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param price_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] # diff --git a/lib/orb/resources/prices/external_price_id.rb b/lib/orb/resources/prices/external_price_id.rb index a20af3eb..45838400 100644 --- a/lib/orb/resources/prices/external_price_id.rb +++ b/lib/orb/resources/prices/external_price_id.rb @@ -8,15 +8,11 @@ class ExternalPriceID # pass null for the metadata value, it will clear any existing metadata for that # price. # - # @param external_price_id [String] - # - # @param params [Orb::Models::Prices::ExternalPriceIDUpdateParams, Hash{Symbol=>Object}] . + # @overload update(external_price_id, metadata: nil, request_options: {}) # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_price_id [String] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] # @@ -36,11 +32,10 @@ def update(external_price_id, params = {}) # [price creation API](/api-reference/price/create-price) for more information # about external price aliases. # - # @param external_price_id [String] - # - # @param params [Orb::Models::Prices::ExternalPriceIDFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(external_price_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param external_price_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] # diff --git a/lib/orb/resources/subscriptions.rb b/lib/orb/resources/subscriptions.rb index e89728f9..a3f41575 100644 --- a/lib/orb/resources/subscriptions.rb +++ b/lib/orb/resources/subscriptions.rb @@ -260,102 +260,40 @@ class Subscriptions # subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit # $10.00 for a subscription that invoices in USD. # - # @param params [Orb::Models::SubscriptionCreateParams, Hash{Symbol=>Object}] . - # - # @option params [Array, nil] :add_adjustments Additional adjustments to be added to the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) - # - # @option params [Array, nil] :add_prices Additional prices to be added to the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) - # - # @option params [Boolean] :align_billing_with_subscription_start_date - # - # @option params [Boolean, nil] :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. - # - # @option params [String, nil] :aws_region - # - # @option params [Orb::Models::SubscriptionCreateParams::BillingCycleAnchorConfiguration, nil] :billing_cycle_anchor_configuration - # - # @option params [String, nil] :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. - # - # @option params [Float, nil] :credits_overage_rate - # - # @option params [String, nil] :customer_id - # - # @option params [String, nil] :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. - # - # @option params [Time, nil] :end_date - # - # @option params [String, nil] :external_customer_id - # - # @option params [Symbol, Orb::Models::SubscriptionCreateParams::ExternalMarketplace, nil] :external_marketplace - # - # @option params [String, nil] :external_marketplace_reporting_id - # - # @option params [String, nil] :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. - # - # @option params [String, nil] :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. - # - # @option params [Integer, nil] :initial_phase_order The phase of the plan to start with - # - # @option params [String, nil] :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. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. - # - # @option params [Integer, nil] :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. - # - # @option params [Float, nil] :per_credit_overage_amount - # - # @option params [String, nil] :plan_id The plan that the given subscription should be switched to. Note that either - # this property or `external_plan_id` must be specified. - # - # @option params [Integer, nil] :plan_version_number Specifies which version of the plan to subscribe to. If null, the default - # version will be used. - # - # @option params [Array, nil] :price_overrides Optionally provide a list of overrides for prices on the plan - # - # @option params [Array, nil] :remove_adjustments Plan adjustments to be removed from the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) - # - # @option params [Array, nil] :remove_prices Plan prices to be removed from the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) - # - # @option params [Array, nil] :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) - # - # @option params [Array, nil] :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) - # - # @option params [Time, nil] :start_date - # - # @option params [Integer, nil] :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. - # - # @option params [Array, nil] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @overload create(add_adjustments: nil, add_prices: nil, align_billing_with_subscription_start_date: nil, auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, coupon_redemption_code: nil, credits_overage_rate: nil, customer_id: nil, default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, start_date: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {}) + # + # @param add_adjustments [Array, nil] + # @param add_prices [Array, nil] + # @param align_billing_with_subscription_start_date [Boolean] + # @param auto_collection [Boolean, nil] + # @param aws_region [String, nil] + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCreateParams::BillingCycleAnchorConfiguration, nil] + # @param coupon_redemption_code [String, nil] + # @param credits_overage_rate [Float, nil] + # @param customer_id [String, nil] + # @param default_invoice_memo [String, nil] + # @param end_date [Time, nil] + # @param external_customer_id [String, nil] + # @param external_marketplace [Symbol, Orb::Models::SubscriptionCreateParams::ExternalMarketplace, nil] + # @param external_marketplace_reporting_id [String, nil] + # @param external_plan_id [String, nil] + # @param filter [String, nil] + # @param initial_phase_order [Integer, nil] + # @param invoicing_threshold [String, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param net_terms [Integer, nil] + # @param per_credit_overage_amount [Float, nil] + # @param plan_id [String, nil] + # @param plan_version_number [Integer, nil] + # @param price_overrides [Array, nil] + # @param remove_adjustments [Array, nil] + # @param remove_prices [Array, nil] + # @param replace_adjustments [Array, nil] + # @param replace_prices [Array, nil] + # @param start_date [Time, nil] + # @param trial_duration_days [Integer, nil] + # @param usage_customer_ids [Array, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionCreateResponse] # @@ -375,31 +313,15 @@ def create(params = {}) # `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties # on a subscription. # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionUpdateParams, Hash{Symbol=>Object}] . - # - # @option params [Boolean, nil] :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. - # - # @option params [String, nil] :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. - # - # @option params [String, nil] :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. - # - # @option params [Hash{Symbol=>String, nil}, nil] :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`. + # @overload update(subscription_id, auto_collection: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {}) # - # @option params [Integer, nil] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param auto_collection [Boolean, nil] + # @param default_invoice_memo [String, nil] + # @param invoicing_threshold [String, nil] + # @param metadata [Hash{Symbol=>String, nil}, nil] + # @param net_terms [Integer, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Subscription] # @@ -425,28 +347,18 @@ def update(subscription_id, params = {}) # for multiple customers, use the customer_id[] or external_customer_id[] query # parameters. # - # @param params [Orb::Models::SubscriptionListParams, Hash{Symbol=>Object}] . - # - # @option params [Time, nil] :created_at_gt - # - # @option params [Time, nil] :created_at_gte - # - # @option params [Time, nil] :created_at_lt - # - # @option params [Time, nil] :created_at_lte - # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Array, nil] :customer_id - # - # @option params [Array, nil] :external_customer_id - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. + # @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: {}) # - # @option params [Symbol, Orb::Models::SubscriptionListParams::Status, nil] :status - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param created_at_gt [Time, nil] + # @param created_at_gte [Time, nil] + # @param created_at_lt [Time, nil] + # @param created_at_lte [Time, nil] + # @param cursor [String, nil] + # @param customer_id [Array, nil] + # @param external_customer_id [Array, nil] + # @param limit [Integer] + # @param status [Symbol, Orb::Models::SubscriptionListParams::Status, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -525,20 +437,13 @@ def list(params = {}) # dates for the subscription. See the section on # [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors). # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionCancelParams, Hash{Symbol=>Object}] . - # - # @option params [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption] :cancel_option Determines the timing of subscription cancellation - # - # @option params [Boolean, nil] :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. + # @overload cancel(subscription_id, cancel_option:, allow_invoice_credit_or_void: nil, cancellation_date: nil, request_options: {}) # - # @option params [Time, nil] :cancellation_date The date that the cancellation should take effect. This parameter can only be - # passed if the `cancel_option` is `requested_date`. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param cancel_option [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption] + # @param allow_invoice_credit_or_void [Boolean, nil] + # @param cancellation_date [Time, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionCancelResponse] # @@ -557,11 +462,10 @@ def cancel(subscription_id, params) # This endpoint is used to fetch a [Subscription](/core-concepts##subscription) # given an identifier. # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionFetchParams, Hash{Symbol=>Object}] . + # @overload fetch(subscription_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::Subscription] # @@ -586,22 +490,14 @@ def fetch(subscription_id, params = {}) # de-aggregate costs when a customer's subscription has started and stopped on the # same day). # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionFetchCostsParams, Hash{Symbol=>Object}] . - # - # @option params [String, nil] :currency The currency or custom pricing unit to use. - # - # @option params [Time, nil] :timeframe_end Costs returned are exclusive of `timeframe_end`. + # @overload fetch_costs(subscription_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}) # - # @option params [Time, nil] :timeframe_start Costs returned are inclusive of `timeframe_start`. - # - # @option params [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param currency [String, nil] + # @param timeframe_end [Time, nil] + # @param timeframe_start [Time, nil] + # @param view_mode [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionFetchCostsResponse] # @@ -622,24 +518,16 @@ def fetch_costs(subscription_id, params = {}) # contains the subscription's initial plan along with past and future plan # changes. # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionFetchScheduleParams, Hash{Symbol=>Object}] . + # @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: {}) # - # @option params [String, nil] :cursor Cursor for pagination. This can be populated by the `next_cursor` value returned - # from the initial request. - # - # @option params [Integer] :limit The number of items to fetch. Defaults to 20. - # - # @option params [Time, nil] :start_date_gt - # - # @option params [Time, nil] :start_date_gte - # - # @option params [Time, nil] :start_date_lt - # - # @option params [Time, nil] :start_date_lte - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param cursor [String, nil] + # @param limit [Integer] + # @param start_date_gt [Time, nil] + # @param start_date_gte [Time, nil] + # @param start_date_lt [Time, nil] + # @param start_date_lte [Time, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Page] # @@ -851,36 +739,20 @@ def fetch_schedule(subscription_id, params = {}) # - `second_dimension_key`: `provider` # - `second_dimension_value`: `aws` # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionFetchUsageParams, Hash{Symbol=>Object}] . + # @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: {}) # - # @option params [String, nil] :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. - # - # @option params [String, nil] :first_dimension_key - # - # @option params [String, nil] :first_dimension_value - # - # @option params [Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity, nil] :granularity This determines the windowing of usage reporting. - # - # @option params [String, nil] :group_by Groups per-price usage by the key provided. - # - # @option params [String, nil] :second_dimension_key - # - # @option params [String, nil] :second_dimension_value - # - # @option params [Time, nil] :timeframe_end Usage returned is exclusive of `timeframe_end`. - # - # @option params [Time, nil] :timeframe_start Usage returned is inclusive of `timeframe_start`. - # - # @option params [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param billable_metric_id [String, nil] + # @param first_dimension_key [String, nil] + # @param first_dimension_value [String, nil] + # @param granularity [Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity, nil] + # @param group_by [String, nil] + # @param second_dimension_key [String, nil] + # @param second_dimension_value [String, nil] + # @param timeframe_end [Time, nil] + # @param timeframe_start [Time, nil] + # @param view_mode [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage] # @@ -969,23 +841,15 @@ def fetch_usage(subscription_id, params = {}) # `fixed_fee_quantity_transitions` property on a subscription’s serialized price # intervals. # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionPriceIntervalsParams, Hash{Symbol=>Object}] . - # - # @option params [Array] :add A list of price intervals to add to the subscription. - # - # @option params [Array] :add_adjustments A list of adjustments to add to the subscription. + # @overload price_intervals(subscription_id, add: nil, add_adjustments: nil, allow_invoice_credit_or_void: nil, edit: nil, edit_adjustments: nil, request_options: {}) # - # @option params [Boolean, nil] :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. - # - # @option params [Array] :edit A list of price intervals to edit on the subscription. - # - # @option params [Array] :edit_adjustments A list of adjustments to edit on the subscription. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param add [Array] + # @param add_adjustments [Array] + # @param allow_invoice_credit_or_void [Boolean, nil] + # @param edit [Array] + # @param edit_adjustments [Array] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionPriceIntervalsResponse] # @@ -1185,97 +1049,36 @@ def price_intervals(subscription_id, params = {}) # behavior, see # [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees). # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionSchedulePlanChangeParams, Hash{Symbol=>Object}] . - # - # @option params [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption] :change_option - # - # @option params [Array, nil] :add_adjustments Additional adjustments to be added to the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) - # - # @option params [Array, nil] :add_prices Additional prices to be added to the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) - # - # @option params [Boolean, nil] :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. - # - # @option params [Boolean, nil] :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. - # - # @option params [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment, nil] :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. - # - # @option params [Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAnchorConfiguration, nil] :billing_cycle_anchor_configuration - # - # @option params [Time, nil] :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. - # - # @option params [String, nil] :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. - # - # @option params [Float, nil] :credits_overage_rate - # - # @option params [String, nil] :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. - # - # @option params [String, nil] :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. - # - # @option params [String, nil] :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. - # - # @option params [Integer, nil] :initial_phase_order The phase of the plan to start with - # - # @option params [String, nil] :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. - # - # @option params [Integer, nil] :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. - # - # @option params [Float, nil] :per_credit_overage_amount + # @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: {}) # - # @option params [String, nil] :plan_id The plan that the given subscription should be switched to. Note that either - # this property or `external_plan_id` must be specified. - # - # @option params [Integer, nil] :plan_version_number Specifies which version of the plan to change to. If null, the default version - # will be used. - # - # @option params [Array, nil] :price_overrides Optionally provide a list of overrides for prices on the plan - # - # @option params [Array, nil] :remove_adjustments Plan adjustments to be removed from the subscription. (Only available for - # accounts that have migrated off of legacy subscription overrides) - # - # @option params [Array, nil] :remove_prices Plan prices to be removed from the subscription. (Only available for accounts - # that have migrated off of legacy subscription overrides) - # - # @option params [Array, nil] :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) - # - # @option params [Array, nil] :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) - # - # @option params [Integer, nil] :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. - # - # @option params [Array, nil] :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. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param change_option [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption] + # @param add_adjustments [Array, nil] + # @param add_prices [Array, nil] + # @param align_billing_with_plan_change_date [Boolean, nil] + # @param auto_collection [Boolean, nil] + # @param billing_cycle_alignment [Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment, nil] + # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAnchorConfiguration, nil] + # @param change_date [Time, nil] + # @param coupon_redemption_code [String, nil] + # @param credits_overage_rate [Float, nil] + # @param default_invoice_memo [String, nil] + # @param external_plan_id [String, nil] + # @param filter [String, nil] + # @param initial_phase_order [Integer, nil] + # @param invoicing_threshold [String, nil] + # @param net_terms [Integer, nil] + # @param per_credit_overage_amount [Float, nil] + # @param plan_id [String, nil] + # @param plan_version_number [Integer, nil] + # @param price_overrides [Array, nil] + # @param remove_adjustments [Array, nil] + # @param remove_prices [Array, nil] + # @param replace_adjustments [Array, nil] + # @param replace_prices [Array, nil] + # @param trial_duration_days [Integer, nil] + # @param usage_customer_ids [Array, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionSchedulePlanChangeResponse] # @@ -1294,18 +1097,12 @@ def schedule_plan_change(subscription_id, params) # Manually trigger a phase, effective the given date (or the current time, if not # specified). # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionTriggerPhaseParams, Hash{Symbol=>Object}] . - # - # @option params [Boolean, nil] :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. + # @overload trigger_phase(subscription_id, allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {}) # - # @option params [Date, nil] :effective_date The date on which the phase change should take effect. If not provided, defaults - # to today in the customer's timezone. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param allow_invoice_credit_or_void [Boolean, nil] + # @param effective_date [Date, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionTriggerPhaseResponse] # @@ -1328,11 +1125,10 @@ def trigger_phase(subscription_id, params = {}) # cancellation. This operation will turn on auto-renew, ensuring that the # subscription does not end at the currently scheduled cancellation time. # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionUnscheduleCancellationParams, Hash{Symbol=>Object}] . + # @overload unschedule_cancellation(subscription_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUnscheduleCancellationResponse] # @@ -1352,13 +1148,11 @@ def unschedule_cancellation(subscription_id, params = {}) # If there are no updates scheduled, a request validation error will be returned # with a 400 status code. # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesParams, Hash{Symbol=>Object}] . - # - # @option params [String] :price_id Price for which the updates should be cleared. Must be a fixed fee. + # @overload unschedule_fixed_fee_quantity_updates(subscription_id, price_id:, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param price_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse] # @@ -1377,11 +1171,10 @@ def unschedule_fixed_fee_quantity_updates(subscription_id, params) # This endpoint can be used to unschedule any pending plan changes on an existing # subscription. # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionUnschedulePendingPlanChangesParams, Hash{Symbol=>Object}] . + # @overload unschedule_pending_plan_changes(subscription_id, request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse] # @@ -1410,27 +1203,15 @@ def unschedule_pending_plan_changes(subscription_id, params = {}) # 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. # - # @param subscription_id [String] - # - # @param params [Orb::Models::SubscriptionUpdateFixedFeeQuantityParams, Hash{Symbol=>Object}] . - # - # @option params [String] :price_id Price for which the quantity should be updated. Must be a fixed fee. - # - # @option params [Float] :quantity + # @overload update_fixed_fee_quantity(subscription_id, price_id:, quantity:, allow_invoice_credit_or_void: nil, change_option: nil, effective_date: nil, request_options: {}) # - # @option params [Boolean, nil] :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. - # - # @option params [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] :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`. - # - # @option params [Date, nil] :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`. - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param price_id [String] + # @param quantity [Float] + # @param allow_invoice_credit_or_void [Boolean, nil] + # @param change_option [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] + # @param effective_date [Date, nil] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse] # @@ -1465,17 +1246,12 @@ def update_fixed_fee_quantity(subscription_id, params) # added, that change will be pushed back by the same amount of time the trial is # extended). # - # @param subscription_id [String] + # @overload update_trial(subscription_id, trial_end_date:, shift: nil, request_options: {}) # - # @param params [Orb::Models::SubscriptionUpdateTrialParams, Hash{Symbol=>Object}] . - # - # @option params [Time, Symbol] :trial_end_date The new date that the trial should end, or the literal string `immediate` to end - # the trial immediately. - # - # @option params [Boolean] :shift If true, shifts subsequent price and adjustment intervals (preserving their - # durations, but adjusting their absolute dates). - # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param subscription_id [String] + # @param trial_end_date [Time, Symbol] + # @param shift [Boolean] + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::SubscriptionUpdateTrialResponse] # diff --git a/lib/orb/resources/top_level.rb b/lib/orb/resources/top_level.rb index 393f131f..e893d7f9 100644 --- a/lib/orb/resources/top_level.rb +++ b/lib/orb/resources/top_level.rb @@ -10,9 +10,9 @@ class TopLevel # # This API does not have any side-effects or return any Orb resources. # - # @param params [Orb::Models::TopLevelPingParams, Hash{Symbol=>Object}] . + # @overload ping(request_options: {}) # - # @option params [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :request_options + # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [Orb::Models::TopLevelPingResponse] # From 6f6cc2972dd0f0863201d4d7642dbec922893364 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 1 Apr 2025 17:54:55 +0000 Subject: [PATCH 4/8] feat: link response models to their methods in yard doc (#198) --- lib/orb/models/alert.rb | 1 + lib/orb/models/billable_metric.rb | 1 + lib/orb/models/coupon.rb | 1 + lib/orb/models/credit_note.rb | 1 + lib/orb/models/customer.rb | 1 + lib/orb/models/customers/balance_transaction_create_response.rb | 1 + lib/orb/models/customers/balance_transaction_list_response.rb | 1 + lib/orb/models/customers/cost_list_by_external_id_response.rb | 1 + lib/orb/models/customers/cost_list_response.rb | 1 + lib/orb/models/customers/credit_list_by_external_id_response.rb | 1 + lib/orb/models/customers/credit_list_response.rb | 1 + .../credits/ledger_create_entry_by_external_id_response.rb | 2 ++ .../models/customers/credits/ledger_create_entry_response.rb | 2 ++ .../customers/credits/ledger_list_by_external_id_response.rb | 2 ++ lib/orb/models/customers/credits/ledger_list_response.rb | 2 ++ .../customers/credits/top_up_create_by_external_id_response.rb | 1 + lib/orb/models/customers/credits/top_up_create_response.rb | 1 + .../customers/credits/top_up_list_by_external_id_response.rb | 1 + lib/orb/models/customers/credits/top_up_list_response.rb | 1 + lib/orb/models/dimensional_price_group.rb | 1 + lib/orb/models/event_deprecate_response.rb | 1 + lib/orb/models/event_ingest_response.rb | 1 + lib/orb/models/event_search_response.rb | 1 + lib/orb/models/event_update_response.rb | 1 + lib/orb/models/events/backfill_close_response.rb | 1 + lib/orb/models/events/backfill_create_response.rb | 1 + lib/orb/models/events/backfill_fetch_response.rb | 1 + lib/orb/models/events/backfill_list_response.rb | 1 + lib/orb/models/events/backfill_revert_response.rb | 1 + lib/orb/models/events/event_volumes.rb | 1 + lib/orb/models/invoice.rb | 1 + lib/orb/models/invoice_fetch_upcoming_response.rb | 1 + lib/orb/models/invoice_line_item_create_response.rb | 1 + lib/orb/models/item.rb | 1 + lib/orb/models/plan.rb | 1 + lib/orb/models/price.rb | 2 ++ lib/orb/models/price_evaluate_response.rb | 1 + lib/orb/models/subscription.rb | 1 + lib/orb/models/subscription_cancel_response.rb | 1 + lib/orb/models/subscription_create_response.rb | 1 + lib/orb/models/subscription_fetch_costs_response.rb | 1 + lib/orb/models/subscription_fetch_schedule_response.rb | 1 + lib/orb/models/subscription_price_intervals_response.rb | 1 + lib/orb/models/subscription_schedule_plan_change_response.rb | 1 + lib/orb/models/subscription_trigger_phase_response.rb | 1 + lib/orb/models/subscription_unschedule_cancellation_response.rb | 1 + ...bscription_unschedule_fixed_fee_quantity_updates_response.rb | 1 + .../subscription_unschedule_pending_plan_changes_response.rb | 1 + .../models/subscription_update_fixed_fee_quantity_response.rb | 1 + lib/orb/models/subscription_update_trial_response.rb | 1 + lib/orb/models/subscription_usage.rb | 1 + lib/orb/models/top_level_ping_response.rb | 1 + 52 files changed, 57 insertions(+) diff --git a/lib/orb/models/alert.rb b/lib/orb/models/alert.rb index 4568689c..b06f1a2d 100644 --- a/lib/orb/models/alert.rb +++ b/lib/orb/models/alert.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Alerts#retrieve class Alert < Orb::BaseModel # @!attribute id # Also referred to as alert_id in this documentation. diff --git a/lib/orb/models/billable_metric.rb b/lib/orb/models/billable_metric.rb index 883b5288..06389247 100644 --- a/lib/orb/models/billable_metric.rb +++ b/lib/orb/models/billable_metric.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Metrics#create class BillableMetric < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/coupon.rb b/lib/orb/models/coupon.rb index ec9abc35..c1fb1825 100644 --- a/lib/orb/models/coupon.rb +++ b/lib/orb/models/coupon.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Coupons#create class Coupon < Orb::BaseModel # @!attribute id # Also referred to as coupon_id in this documentation. diff --git a/lib/orb/models/credit_note.rb b/lib/orb/models/credit_note.rb index b34c7a9f..c4802ccf 100644 --- a/lib/orb/models/credit_note.rb +++ b/lib/orb/models/credit_note.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::CreditNotes#create class CreditNote < Orb::BaseModel # @!attribute id # The Orb id of this credit note. diff --git a/lib/orb/models/customer.rb b/lib/orb/models/customer.rb index f9bf0e73..450555aa 100644 --- a/lib/orb/models/customer.rb +++ b/lib/orb/models/customer.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Customers#create class Customer < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/customers/balance_transaction_create_response.rb b/lib/orb/models/customers/balance_transaction_create_response.rb index 872bb78c..982b2c37 100644 --- a/lib/orb/models/customers/balance_transaction_create_response.rb +++ b/lib/orb/models/customers/balance_transaction_create_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::BalanceTransactions#create class BalanceTransactionCreateResponse < Orb::BaseModel # @!attribute id # A unique id for this transaction. diff --git a/lib/orb/models/customers/balance_transaction_list_response.rb b/lib/orb/models/customers/balance_transaction_list_response.rb index f942a045..055344d4 100644 --- a/lib/orb/models/customers/balance_transaction_list_response.rb +++ b/lib/orb/models/customers/balance_transaction_list_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::BalanceTransactions#list class BalanceTransactionListResponse < Orb::BaseModel # @!attribute id # A unique id for this transaction. diff --git a/lib/orb/models/customers/cost_list_by_external_id_response.rb b/lib/orb/models/customers/cost_list_by_external_id_response.rb index 57b041d4..1ccf5cf8 100644 --- a/lib/orb/models/customers/cost_list_by_external_id_response.rb +++ b/lib/orb/models/customers/cost_list_by_external_id_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::Costs#list_by_external_id class CostListByExternalIDResponse < Orb::BaseModel # @!attribute data # diff --git a/lib/orb/models/customers/cost_list_response.rb b/lib/orb/models/customers/cost_list_response.rb index a21bca75..31433b27 100644 --- a/lib/orb/models/customers/cost_list_response.rb +++ b/lib/orb/models/customers/cost_list_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::Costs#list class CostListResponse < Orb::BaseModel # @!attribute data # diff --git a/lib/orb/models/customers/credit_list_by_external_id_response.rb b/lib/orb/models/customers/credit_list_by_external_id_response.rb index 7141b0b9..f30e6a0d 100644 --- a/lib/orb/models/customers/credit_list_by_external_id_response.rb +++ b/lib/orb/models/customers/credit_list_by_external_id_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::Credits#list_by_external_id class CreditListByExternalIDResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/customers/credit_list_response.rb b/lib/orb/models/customers/credit_list_response.rb index b1baf1ca..6a8a23b3 100644 --- a/lib/orb/models/customers/credit_list_response.rb +++ b/lib/orb/models/customers/credit_list_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Customers + # @see Orb::Resources::Customers::Credits#list class CreditListResponse < Orb::BaseModel # @!attribute id # 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 db32c752..e3ea2e4a 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 @@ -6,6 +6,8 @@ module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid # credits within Orb. + # + # @see Orb::Resources::Customers::Credits::Ledger#create_entry_by_external_id module LedgerCreateEntryByExternalIDResponse extend Orb::Union 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 44dc7eb7..2b323b95 100644 --- a/lib/orb/models/customers/credits/ledger_create_entry_response.rb +++ b/lib/orb/models/customers/credits/ledger_create_entry_response.rb @@ -6,6 +6,8 @@ module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid # credits within Orb. + # + # @see Orb::Resources::Customers::Credits::Ledger#create_entry module LedgerCreateEntryResponse extend Orb::Union 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 b2ba4d0a..2ec81234 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 @@ -6,6 +6,8 @@ module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid # credits within Orb. + # + # @see Orb::Resources::Customers::Credits::Ledger#list_by_external_id module LedgerListByExternalIDResponse extend Orb::Union diff --git a/lib/orb/models/customers/credits/ledger_list_response.rb b/lib/orb/models/customers/credits/ledger_list_response.rb index 03b4bfa0..fac7e6e6 100644 --- a/lib/orb/models/customers/credits/ledger_list_response.rb +++ b/lib/orb/models/customers/credits/ledger_list_response.rb @@ -6,6 +6,8 @@ module Customers module Credits # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid # credits within Orb. + # + # @see Orb::Resources::Customers::Credits::Ledger#list module LedgerListResponse extend Orb::Union 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 72cc678e..124fa310 100644 --- a/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +++ b/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#create_by_external_id class TopUpCreateByExternalIDResponse < Orb::BaseModel # @!attribute id # 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 8f3e048b..a0b3477f 100644 --- a/lib/orb/models/customers/credits/top_up_create_response.rb +++ b/lib/orb/models/customers/credits/top_up_create_response.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#create class TopUpCreateResponse < Orb::BaseModel # @!attribute id # 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 e4b74f74..17ca117a 100644 --- a/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +++ b/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#list_by_external_id class TopUpListByExternalIDResponse < Orb::BaseModel # @!attribute id # 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 5d605656..2e9644c6 100644 --- a/lib/orb/models/customers/credits/top_up_list_response.rb +++ b/lib/orb/models/customers/credits/top_up_list_response.rb @@ -4,6 +4,7 @@ module Orb module Models module Customers module Credits + # @see Orb::Resources::Customers::Credits::TopUps#list class TopUpListResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/dimensional_price_group.rb b/lib/orb/models/dimensional_price_group.rb index d7c1066e..18d514ed 100644 --- a/lib/orb/models/dimensional_price_group.rb +++ b/lib/orb/models/dimensional_price_group.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::DimensionalPriceGroups#create class DimensionalPriceGroup < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/event_deprecate_response.rb b/lib/orb/models/event_deprecate_response.rb index b07dbc50..9cd7357e 100644 --- a/lib/orb/models/event_deprecate_response.rb +++ b/lib/orb/models/event_deprecate_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Events#deprecate class EventDeprecateResponse < Orb::BaseModel # @!attribute deprecated # event_id of the deprecated event, if successfully updated diff --git a/lib/orb/models/event_ingest_response.rb b/lib/orb/models/event_ingest_response.rb index a2e7e0c9..52811f08 100644 --- a/lib/orb/models/event_ingest_response.rb +++ b/lib/orb/models/event_ingest_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Events#ingest class EventIngestResponse < Orb::BaseModel # @!attribute validation_failed # Contains all failing validation events. In the case of a 200, this array will diff --git a/lib/orb/models/event_search_response.rb b/lib/orb/models/event_search_response.rb index 406d95fc..b6342aaa 100644 --- a/lib/orb/models/event_search_response.rb +++ b/lib/orb/models/event_search_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Events#search class EventSearchResponse < Orb::BaseModel # @!attribute data # diff --git a/lib/orb/models/event_update_response.rb b/lib/orb/models/event_update_response.rb index 80989444..f4f4314b 100644 --- a/lib/orb/models/event_update_response.rb +++ b/lib/orb/models/event_update_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Events#update class EventUpdateResponse < Orb::BaseModel # @!attribute amended # event_id of the amended event, if successfully ingested diff --git a/lib/orb/models/events/backfill_close_response.rb b/lib/orb/models/events/backfill_close_response.rb index ee69ee98..532ac0f4 100644 --- a/lib/orb/models/events/backfill_close_response.rb +++ b/lib/orb/models/events/backfill_close_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#close class BackfillCloseResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/backfill_create_response.rb b/lib/orb/models/events/backfill_create_response.rb index 24b9b89f..42a6f2c5 100644 --- a/lib/orb/models/events/backfill_create_response.rb +++ b/lib/orb/models/events/backfill_create_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#create class BackfillCreateResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/backfill_fetch_response.rb b/lib/orb/models/events/backfill_fetch_response.rb index 7a05b477..758e55dd 100644 --- a/lib/orb/models/events/backfill_fetch_response.rb +++ b/lib/orb/models/events/backfill_fetch_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#fetch class BackfillFetchResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/backfill_list_response.rb b/lib/orb/models/events/backfill_list_response.rb index 29c0618b..89c98759 100644 --- a/lib/orb/models/events/backfill_list_response.rb +++ b/lib/orb/models/events/backfill_list_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#list class BackfillListResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/backfill_revert_response.rb b/lib/orb/models/events/backfill_revert_response.rb index a378ab22..556150e6 100644 --- a/lib/orb/models/events/backfill_revert_response.rb +++ b/lib/orb/models/events/backfill_revert_response.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Backfills#revert class BackfillRevertResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/events/event_volumes.rb b/lib/orb/models/events/event_volumes.rb index 0f3ff561..c9365953 100644 --- a/lib/orb/models/events/event_volumes.rb +++ b/lib/orb/models/events/event_volumes.rb @@ -3,6 +3,7 @@ module Orb module Models module Events + # @see Orb::Resources::Events::Volume#list class EventVolumes < Orb::BaseModel # @!attribute data # diff --git a/lib/orb/models/invoice.rb b/lib/orb/models/invoice.rb index 3b0e02b3..5d97bf8a 100644 --- a/lib/orb/models/invoice.rb +++ b/lib/orb/models/invoice.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#create class Invoice < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/invoice_fetch_upcoming_response.rb b/lib/orb/models/invoice_fetch_upcoming_response.rb index 321a50f3..8220902e 100644 --- a/lib/orb/models/invoice_fetch_upcoming_response.rb +++ b/lib/orb/models/invoice_fetch_upcoming_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Invoices#fetch_upcoming class InvoiceFetchUpcomingResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/invoice_line_item_create_response.rb b/lib/orb/models/invoice_line_item_create_response.rb index 1abed7ec..f1422a77 100644 --- a/lib/orb/models/invoice_line_item_create_response.rb +++ b/lib/orb/models/invoice_line_item_create_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::InvoiceLineItems#create class InvoiceLineItemCreateResponse < Orb::BaseModel # @!attribute id # A unique ID for this line item. diff --git a/lib/orb/models/item.rb b/lib/orb/models/item.rb index 647b06c6..ef72aafd 100644 --- a/lib/orb/models/item.rb +++ b/lib/orb/models/item.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Items#create class Item < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/plan.rb b/lib/orb/models/plan.rb index 312b38d4..720c0f79 100644 --- a/lib/orb/models/plan.rb +++ b/lib/orb/models/plan.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Plans#create class Plan < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/price.rb b/lib/orb/models/price.rb index 865f84da..8396185e 100644 --- a/lib/orb/models/price.rb +++ b/lib/orb/models/price.rb @@ -12,6 +12,8 @@ module Models # # For more on the types of prices, see # [the core concepts documentation](/core-concepts#plan-and-price) + # + # @see Orb::Resources::Prices#create module Price extend Orb::Union diff --git a/lib/orb/models/price_evaluate_response.rb b/lib/orb/models/price_evaluate_response.rb index 800a37ed..3b146da0 100644 --- a/lib/orb/models/price_evaluate_response.rb +++ b/lib/orb/models/price_evaluate_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Prices#evaluate class PriceEvaluateResponse < Orb::BaseModel # @!attribute data # diff --git a/lib/orb/models/subscription.rb b/lib/orb/models/subscription.rb index a515305b..c273be67 100644 --- a/lib/orb/models/subscription.rb +++ b/lib/orb/models/subscription.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#update class Subscription < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_cancel_response.rb b/lib/orb/models/subscription_cancel_response.rb index 56913070..643976ff 100644 --- a/lib/orb/models/subscription_cancel_response.rb +++ b/lib/orb/models/subscription_cancel_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#cancel class SubscriptionCancelResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_create_response.rb b/lib/orb/models/subscription_create_response.rb index 4a4fb60d..424b0ba2 100644 --- a/lib/orb/models/subscription_create_response.rb +++ b/lib/orb/models/subscription_create_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#create class SubscriptionCreateResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_fetch_costs_response.rb b/lib/orb/models/subscription_fetch_costs_response.rb index 9ed47e19..4da2c554 100644 --- a/lib/orb/models/subscription_fetch_costs_response.rb +++ b/lib/orb/models/subscription_fetch_costs_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#fetch_costs class SubscriptionFetchCostsResponse < Orb::BaseModel # @!attribute data # diff --git a/lib/orb/models/subscription_fetch_schedule_response.rb b/lib/orb/models/subscription_fetch_schedule_response.rb index 5234e19d..d3c9dd6f 100644 --- a/lib/orb/models/subscription_fetch_schedule_response.rb +++ b/lib/orb/models/subscription_fetch_schedule_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#fetch_schedule class SubscriptionFetchScheduleResponse < Orb::BaseModel # @!attribute created_at # diff --git a/lib/orb/models/subscription_price_intervals_response.rb b/lib/orb/models/subscription_price_intervals_response.rb index dac70ab6..48856dcc 100644 --- a/lib/orb/models/subscription_price_intervals_response.rb +++ b/lib/orb/models/subscription_price_intervals_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#price_intervals class SubscriptionPriceIntervalsResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_schedule_plan_change_response.rb b/lib/orb/models/subscription_schedule_plan_change_response.rb index 8f6b8ead..307cf9ab 100644 --- a/lib/orb/models/subscription_schedule_plan_change_response.rb +++ b/lib/orb/models/subscription_schedule_plan_change_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#schedule_plan_change class SubscriptionSchedulePlanChangeResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_trigger_phase_response.rb b/lib/orb/models/subscription_trigger_phase_response.rb index 295d4453..28254947 100644 --- a/lib/orb/models/subscription_trigger_phase_response.rb +++ b/lib/orb/models/subscription_trigger_phase_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#trigger_phase class SubscriptionTriggerPhaseResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_unschedule_cancellation_response.rb b/lib/orb/models/subscription_unschedule_cancellation_response.rb index a18f7389..c0db57b4 100644 --- a/lib/orb/models/subscription_unschedule_cancellation_response.rb +++ b/lib/orb/models/subscription_unschedule_cancellation_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#unschedule_cancellation class SubscriptionUnscheduleCancellationResponse < Orb::BaseModel # @!attribute id # 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 b918b2c7..f588490e 100644 --- a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +++ b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#unschedule_fixed_fee_quantity_updates class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::BaseModel # @!attribute id # 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 d68d524f..29b29a8c 100644 --- a/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +++ b/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#unschedule_pending_plan_changes class SubscriptionUnschedulePendingPlanChangesResponse < Orb::BaseModel # @!attribute id # 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 bdd3ada4..c1488c33 100644 --- a/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +++ b/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#update_fixed_fee_quantity class SubscriptionUpdateFixedFeeQuantityResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_update_trial_response.rb b/lib/orb/models/subscription_update_trial_response.rb index e2b05007..15040c54 100644 --- a/lib/orb/models/subscription_update_trial_response.rb +++ b/lib/orb/models/subscription_update_trial_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#update_trial class SubscriptionUpdateTrialResponse < Orb::BaseModel # @!attribute id # diff --git a/lib/orb/models/subscription_usage.rb b/lib/orb/models/subscription_usage.rb index a5402596..0fc306d8 100644 --- a/lib/orb/models/subscription_usage.rb +++ b/lib/orb/models/subscription_usage.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::Subscriptions#fetch_usage module SubscriptionUsage extend Orb::Union diff --git a/lib/orb/models/top_level_ping_response.rb b/lib/orb/models/top_level_ping_response.rb index 55e06014..261d18ba 100644 --- a/lib/orb/models/top_level_ping_response.rb +++ b/lib/orb/models/top_level_ping_response.rb @@ -2,6 +2,7 @@ module Orb module Models + # @see Orb::Resources::TopLevel#ping class TopLevelPingResponse < Orb::BaseModel # @!attribute response # From 70d35b67ae45e59e17e3cbc8b490094b5e74ae75 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 1 Apr 2025 23:12:52 +0000 Subject: [PATCH 5/8] chore(internal): codegen related update (#199) --- .../subscription_update_trial_params.rb | 4 +- lib/orb/resources/subscriptions.rb | 2 +- rbi/lib/orb/models/alert.rbi | 2 +- .../alert_create_for_customer_params.rbi | 3 +- ...rt_create_for_external_customer_params.rbi | 2 +- .../alert_create_for_subscription_params.rbi | 2 +- rbi/lib/orb/models/amount_discount.rbi | 3 +- rbi/lib/orb/models/billable_metric.rbi | 2 +- .../models/billing_cycle_relative_date.rbi | 2 +- rbi/lib/orb/models/credit_note.rbi | 11 +- .../orb/models/credit_note_create_params.rbi | 3 +- rbi/lib/orb/models/customer.rbi | 7 +- rbi/lib/orb/models/customer_create_params.rbi | 7 +- .../customer_update_by_external_id_params.rbi | 6 +- rbi/lib/orb/models/customer_update_params.rbi | 7 +- .../balance_transaction_create_params.rbi | 2 +- .../balance_transaction_create_response.rbi | 4 +- .../balance_transaction_list_response.rbi | 4 +- .../cost_list_by_external_id_params.rbi | 2 +- .../orb/models/customers/cost_list_params.rbi | 3 +- .../credit_list_by_external_id_response.rbi | 2 +- .../models/customers/credit_list_response.rbi | 2 +- ...ger_create_entry_by_external_id_params.rbi | 2 + ...r_create_entry_by_external_id_response.rbi | 7 + .../credits/ledger_create_entry_params.rbi | 4 +- .../credits/ledger_create_entry_response.rbi | 7 + .../ledger_list_by_external_id_params.rbi | 16 +- .../ledger_list_by_external_id_response.rbi | 7 + .../customers/credits/ledger_list_params.rbi | 4 +- .../credits/ledger_list_response.rbi | 7 + .../top_up_create_by_external_id_params.rbi | 1 + .../top_up_create_by_external_id_response.rbi | 1 + .../credits/top_up_create_params.rbi | 2 +- .../credits/top_up_create_response.rbi | 8 +- .../top_up_list_by_external_id_response.rbi | 1 + .../credits/top_up_list_response.rbi | 2 +- .../models/events/backfill_close_response.rbi | 2 +- .../events/backfill_create_response.rbi | 2 +- .../models/events/backfill_fetch_response.rbi | 2 +- .../models/events/backfill_list_response.rbi | 2 +- .../events/backfill_revert_response.rbi | 2 +- rbi/lib/orb/models/invoice.rbi | 16 +- rbi/lib/orb/models/invoice_create_params.rbi | 2 +- .../invoice_fetch_upcoming_response.rbi | 32 +- rbi/lib/orb/models/invoice_list_params.rbi | 4 +- rbi/lib/orb/models/item.rbi | 2 +- rbi/lib/orb/models/item_update_params.rbi | 8 +- rbi/lib/orb/models/percentage_discount.rbi | 3 +- rbi/lib/orb/models/plan.rbi | 8 +- rbi/lib/orb/models/plan_create_params.rbi | 134 ++++++++- rbi/lib/orb/models/plan_list_params.rbi | 2 +- rbi/lib/orb/models/price.rbi | 284 +++++++++++++----- rbi/lib/orb/models/price_create_params.rbi | 21 +- rbi/lib/orb/models/subscription.rbi | 2 +- .../orb/models/subscription_cancel_params.rbi | 2 +- .../models/subscription_cancel_response.rbi | 3 +- .../orb/models/subscription_create_params.rbi | 184 +++++++++++- .../models/subscription_create_response.rbi | 3 +- .../subscription_fetch_costs_params.rbi | 2 +- .../subscription_fetch_usage_params.rbi | 4 +- .../orb/models/subscription_list_params.rbi | 3 +- .../subscription_price_intervals_params.rbi | 92 +++++- .../subscription_price_intervals_response.rbi | 2 +- ...bscription_schedule_plan_change_params.rbi | 164 +++++++++- ...cription_schedule_plan_change_response.rbi | 2 +- .../subscription_trigger_phase_response.rbi | 2 +- ...ption_unschedule_cancellation_response.rbi | 2 +- ...le_fixed_fee_quantity_updates_response.rbi | 8 +- ...schedule_pending_plan_changes_response.rbi | 2 +- ...ption_update_fixed_fee_quantity_params.rbi | 2 +- ...ion_update_fixed_fee_quantity_response.rbi | 2 +- .../subscription_update_trial_params.rbi | 2 +- .../subscription_update_trial_response.rbi | 2 +- rbi/lib/orb/models/subscription_usage.rbi | 16 +- rbi/lib/orb/models/trial_discount.rbi | 2 +- rbi/lib/orb/models/usage_discount.rbi | 2 +- 76 files changed, 985 insertions(+), 197 deletions(-) diff --git a/lib/orb/models/subscription_update_trial_params.rb b/lib/orb/models/subscription_update_trial_params.rb index b59e5ddf..e3b6bb03 100644 --- a/lib/orb/models/subscription_update_trial_params.rb +++ b/lib/orb/models/subscription_update_trial_params.rb @@ -12,7 +12,7 @@ class SubscriptionUpdateTrialParams < Orb::BaseModel # The new date that the trial should end, or the literal string `immediate` to end # the trial immediately. # - # @return [Time, Symbol] + # @return [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] required :trial_end_date, union: -> { Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate } # @!attribute [r] shift @@ -27,7 +27,7 @@ class SubscriptionUpdateTrialParams < Orb::BaseModel # attr_writer :shift # @!parse - # # @param trial_end_date [Time, Symbol] + # # @param trial_end_date [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] # # @param shift [Boolean] # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}] # # diff --git a/lib/orb/resources/subscriptions.rb b/lib/orb/resources/subscriptions.rb index a3f41575..456cb15f 100644 --- a/lib/orb/resources/subscriptions.rb +++ b/lib/orb/resources/subscriptions.rb @@ -1249,7 +1249,7 @@ def update_fixed_fee_quantity(subscription_id, params) # @overload update_trial(subscription_id, trial_end_date:, shift: nil, request_options: {}) # # @param subscription_id [String] - # @param trial_end_date [Time, Symbol] + # @param trial_end_date [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] # @param shift [Boolean] # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/rbi/lib/orb/models/alert.rbi b/rbi/lib/orb/models/alert.rbi index aa5cd68e..da2b338b 100644 --- a/rbi/lib/orb/models/alert.rbi +++ b/rbi/lib/orb/models/alert.rbi @@ -222,7 +222,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Alert::Type) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Alert::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Alert::Type::TaggedSymbol) } CREDIT_BALANCE_DEPLETED = T.let(:credit_balance_depleted, Orb::Models::Alert::Type::TaggedSymbol) CREDIT_BALANCE_DROPPED = T.let(:credit_balance_dropped, Orb::Models::Alert::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/alert_create_for_customer_params.rbi b/rbi/lib/orb/models/alert_create_for_customer_params.rbi index 302c1a9d..8361840c 100644 --- a/rbi/lib/orb/models/alert_create_for_customer_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_customer_params.rbi @@ -49,7 +49,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForCustomerParams::Type) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol) } CREDIT_BALANCE_DEPLETED = T.let(:credit_balance_depleted, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol) 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 4a345e39..f23acd2e 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 @@ -52,7 +52,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol) } CREDIT_BALANCE_DEPLETED = T.let(:credit_balance_depleted, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol) 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 09db0241..2f773218 100644 --- a/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +++ b/rbi/lib/orb/models/alert_create_for_subscription_params.rbi @@ -68,7 +68,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol) } USAGE_EXCEEDED = T.let(:usage_exceeded, Orb::Models::AlertCreateForSubscriptionParams::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/amount_discount.rbi b/rbi/lib/orb/models/amount_discount.rbi index daf5f66f..9b12a5a1 100644 --- a/rbi/lib/orb/models/amount_discount.rbi +++ b/rbi/lib/orb/models/amount_discount.rbi @@ -48,7 +48,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AmountDiscount::DiscountType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol) } AMOUNT = T.let(:amount, Orb::Models::AmountDiscount::DiscountType::TaggedSymbol) diff --git a/rbi/lib/orb/models/billable_metric.rbi b/rbi/lib/orb/models/billable_metric.rbi index f7864c3d..55c8967a 100644 --- a/rbi/lib/orb/models/billable_metric.rbi +++ b/rbi/lib/orb/models/billable_metric.rbi @@ -68,7 +68,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillableMetric::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::BillableMetric::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::BillableMetric::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::BillableMetric::Status::TaggedSymbol) DRAFT = T.let(:draft, Orb::Models::BillableMetric::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/billing_cycle_relative_date.rbi b/rbi/lib/orb/models/billing_cycle_relative_date.rbi index 6c78f7cc..6d5eb8ad 100644 --- a/rbi/lib/orb/models/billing_cycle_relative_date.rbi +++ b/rbi/lib/orb/models/billing_cycle_relative_date.rbi @@ -6,7 +6,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::BillingCycleRelativeDate) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) } START_OF_TERM = T.let(:start_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) END_OF_TERM = T.let(:end_of_term, Orb::Models::BillingCycleRelativeDate::TaggedSymbol) diff --git a/rbi/lib/orb/models/credit_note.rbi b/rbi/lib/orb/models/credit_note.rbi index 07de6230..f08f8605 100644 --- a/rbi/lib/orb/models/credit_note.rbi +++ b/rbi/lib/orb/models/credit_note.rbi @@ -333,7 +333,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol) } PERCENTAGE = T.let(:percentage, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol) AMOUNT = T.let(:amount, Orb::Models::CreditNote::LineItem::Discount::DiscountType::TaggedSymbol) @@ -404,7 +404,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol) } PERCENTAGE = T.let(:percentage, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType::TaggedSymbol) @@ -435,7 +435,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::Reason) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::CreditNote::Reason::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::Reason::TaggedSymbol) } DUPLICATE = T.let(:Duplicate, Orb::Models::CreditNote::Reason::TaggedSymbol) FRAUDULENT = T.let(:Fraudulent, Orb::Models::CreditNote::Reason::TaggedSymbol) @@ -451,7 +451,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::Type) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::CreditNote::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::Type::TaggedSymbol) } REFUND = T.let(:refund, Orb::Models::CreditNote::Type::TaggedSymbol) ADJUSTMENT = T.let(:adjustment, Orb::Models::CreditNote::Type::TaggedSymbol) @@ -515,7 +515,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNote::Discount::DiscountType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::CreditNote::Discount::DiscountType::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::CreditNote::Discount::DiscountType::TaggedSymbol) } PERCENTAGE = T.let(:percentage, Orb::Models::CreditNote::Discount::DiscountType::TaggedSymbol) diff --git a/rbi/lib/orb/models/credit_note_create_params.rbi b/rbi/lib/orb/models/credit_note_create_params.rbi index 812b5030..ae4f3fa7 100644 --- a/rbi/lib/orb/models/credit_note_create_params.rbi +++ b/rbi/lib/orb/models/credit_note_create_params.rbi @@ -66,7 +66,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CreditNoteCreateParams::Reason) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol) } DUPLICATE = T.let(:duplicate, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol) FRAUDULENT = T.let(:fraudulent, Orb::Models::CreditNoteCreateParams::Reason::TaggedSymbol) diff --git a/rbi/lib/orb/models/customer.rbi b/rbi/lib/orb/models/customer.rbi index d2fb76e4..149302c9 100644 --- a/rbi/lib/orb/models/customer.rbi +++ b/rbi/lib/orb/models/customer.rbi @@ -449,7 +449,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::PaymentProvider) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Customer::PaymentProvider::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Customer::PaymentProvider::TaggedSymbol) } QUICKBOOKS = T.let(:quickbooks, Orb::Models::Customer::PaymentProvider::TaggedSymbol) BILL_COM = T.let(:"bill.com", Orb::Models::Customer::PaymentProvider::TaggedSymbol) @@ -655,7 +655,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::TaxID::Country) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Customer::TaxID::Country::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Customer::TaxID::Country::TaggedSymbol) } AD = T.let(:AD, Orb::Models::Customer::TaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::Customer::TaxID::Country::TaggedSymbol) @@ -745,7 +745,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customer::TaxID::Type) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Customer::TaxID::Type::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Customer::TaxID::Type::TaggedSymbol) } AD_NRT = T.let(:ad_nrt, Orb::Models::Customer::TaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::Customer::TaxID::Type::TaggedSymbol) @@ -896,6 +896,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType::TaggedSymbol ) end diff --git a/rbi/lib/orb/models/customer_create_params.rbi b/rbi/lib/orb/models/customer_create_params.rbi index 78d34610..76179ce1 100644 --- a/rbi/lib/orb/models/customer_create_params.rbi +++ b/rbi/lib/orb/models/customer_create_params.rbi @@ -469,7 +469,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerCreateParams::PaymentProvider) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::CustomerCreateParams::PaymentProvider::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::CustomerCreateParams::PaymentProvider::TaggedSymbol) } QUICKBOOKS = T.let(:quickbooks, Orb::Models::CustomerCreateParams::PaymentProvider::TaggedSymbol) BILL_COM = T.let(:"bill.com", Orb::Models::CustomerCreateParams::PaymentProvider::TaggedSymbol) @@ -748,7 +748,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerCreateParams::TaxID::Country) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::CustomerCreateParams::TaxID::Country::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::CustomerCreateParams::TaxID::Country::TaggedSymbol) } AD = T.let(:AD, Orb::Models::CustomerCreateParams::TaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::CustomerCreateParams::TaxID::Country::TaggedSymbol) @@ -838,7 +838,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerCreateParams::TaxID::Type) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::CustomerCreateParams::TaxID::Type::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::CustomerCreateParams::TaxID::Type::TaggedSymbol) } AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerCreateParams::TaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::CustomerCreateParams::TaxID::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customer_update_by_external_id_params.rbi b/rbi/lib/orb/models/customer_update_by_external_id_params.rbi index 7a72e7ef..4b7da25e 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 @@ -486,7 +486,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol) } QUICKBOOKS = T.let(:quickbooks, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol) @@ -770,7 +770,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) } AD = T.let(:AD, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) @@ -861,7 +861,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) } AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customer_update_params.rbi b/rbi/lib/orb/models/customer_update_params.rbi index 049a0006..77edd7bc 100644 --- a/rbi/lib/orb/models/customer_update_params.rbi +++ b/rbi/lib/orb/models/customer_update_params.rbi @@ -465,7 +465,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) } QUICKBOOKS = T.let(:quickbooks, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) BILL_COM = T.let(:"bill.com", Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) @@ -744,7 +744,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) } AD = T.let(:AD, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) @@ -834,7 +834,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) } AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi b/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi index 3ca11bff..9bc64b91 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi @@ -49,7 +49,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) } INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi b/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi index d4d68a2e..ff223668 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi @@ -113,7 +113,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) } APPLIED_TO_INVOICE = T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) @@ -182,7 +182,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) } INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) 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 866c57d7..12b83769 100644 --- a/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +++ b/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi @@ -113,7 +113,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) } APPLIED_TO_INVOICE = T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) @@ -176,7 +176,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) } INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi b/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi index 63ee2960..cdb28ca1 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 @@ -70,7 +70,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) } PERIODIC = T.let(:periodic, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) CUMULATIVE = diff --git a/rbi/lib/orb/models/customers/cost_list_params.rbi b/rbi/lib/orb/models/customers/cost_list_params.rbi index 747422d1..c62398b5 100644 --- a/rbi/lib/orb/models/customers/cost_list_params.rbi +++ b/rbi/lib/orb/models/customers/cost_list_params.rbi @@ -68,7 +68,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CostListParams::ViewMode) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol) } PERIODIC = T.let(:periodic, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol) CUMULATIVE = T.let(:cumulative, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi index 85d444c7..42fb5fd3 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 @@ -71,7 +71,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol) PENDING_PAYMENT = diff --git a/rbi/lib/orb/models/customers/credit_list_response.rbi b/rbi/lib/orb/models/customers/credit_list_response.rbi index 4c7cc912..5bac7f3a 100644 --- a/rbi/lib/orb/models/customers/credit_list_response.rbi +++ b/rbi/lib/orb/models/customers/credit_list_response.rbi @@ -70,7 +70,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::CreditListResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol) PENDING_PAYMENT = diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi index 1c5a3481..8783bef1 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 @@ -157,6 +157,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::TaggedSymbol ) end @@ -242,6 +243,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::TaggedSymbol ) 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 d516638b..a1a1b4e7 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 @@ -208,6 +208,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -453,6 +454,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -686,6 +688,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -913,6 +916,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1148,6 +1152,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1393,6 +1398,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1620,6 +1626,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol ) 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 2d0dd303..88de915d 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 @@ -144,7 +144,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType::TaggedSymbol) } AMENDMENT = T.let(:amendment, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType::TaggedSymbol) @@ -219,7 +219,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason::TaggedSymbol) } REFUND = T.let(:refund, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi index 1d800454..79def855 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 @@ -200,6 +200,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -437,6 +438,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -666,6 +668,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -893,6 +896,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1122,6 +1126,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1357,6 +1362,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1576,6 +1582,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol ) 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 1b174df2..1e0a24d2 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 @@ -103,7 +103,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus::TaggedSymbol + ) + end COMMITTED = T.let( @@ -129,7 +135,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType::TaggedSymbol + ) + end INCREMENT = T.let(:increment, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi index fd218045..b6a5e409 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 @@ -204,6 +204,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -445,6 +446,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -678,6 +680,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -905,6 +908,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1136,6 +1140,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1381,6 +1386,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1604,6 +1610,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol ) 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 e111895f..ae7384c8 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi @@ -103,7 +103,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus::TaggedSymbol) } COMMITTED = T.let(:committed, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus::TaggedSymbol) @@ -120,7 +120,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol) } INCREMENT = T.let(:increment, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol) DECREMENT = T.let(:decrement, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi b/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi index 8ac0c292..9607c291 100644 --- a/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +++ b/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi @@ -198,6 +198,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -431,6 +432,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -654,6 +656,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -873,6 +876,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1092,6 +1096,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1325,6 +1330,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol ) end @@ -1540,6 +1546,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol ) 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 68c4fc93..7419faaf 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 @@ -164,6 +164,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit::TaggedSymbol ) 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 0bb5cede..a40dc23a 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 @@ -166,6 +166,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol ) 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 ae8f10a6..36978abd 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 @@ -157,7 +157,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol) } DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol) MONTH = T.let(:month, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit::TaggedSymbol) diff --git a/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi index c947802a..5c7766fe 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 @@ -149,7 +149,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit::TaggedSymbol) MONTH = diff --git a/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi b/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi index 82c5724f..0904ab70 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 @@ -156,6 +156,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit::TaggedSymbol ) 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 dbf77fe2..774bce1f 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 @@ -149,7 +149,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol) } DAY = T.let(:day, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol) MONTH = T.let(:month, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/backfill_close_response.rbi b/rbi/lib/orb/models/events/backfill_close_response.rbi index 4fe049b4..68175b3b 100644 --- a/rbi/lib/orb/models/events/backfill_close_response.rbi +++ b/rbi/lib/orb/models/events/backfill_close_response.rbi @@ -110,7 +110,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillCloseResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) } PENDING = T.let(:pending, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/backfill_create_response.rbi b/rbi/lib/orb/models/events/backfill_create_response.rbi index 25f6fa57..4ea03f33 100644 --- a/rbi/lib/orb/models/events/backfill_create_response.rbi +++ b/rbi/lib/orb/models/events/backfill_create_response.rbi @@ -110,7 +110,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillCreateResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) } PENDING = T.let(:pending, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillCreateResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/backfill_fetch_response.rbi b/rbi/lib/orb/models/events/backfill_fetch_response.rbi index d890dd31..fe1229d9 100644 --- a/rbi/lib/orb/models/events/backfill_fetch_response.rbi +++ b/rbi/lib/orb/models/events/backfill_fetch_response.rbi @@ -110,7 +110,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillFetchResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol) } PENDING = T.let(:pending, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillFetchResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/backfill_list_response.rbi b/rbi/lib/orb/models/events/backfill_list_response.rbi index c7eaf12e..1bded08c 100644 --- a/rbi/lib/orb/models/events/backfill_list_response.rbi +++ b/rbi/lib/orb/models/events/backfill_list_response.rbi @@ -110,7 +110,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillListResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol) } PENDING = T.let(:pending, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillListResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/events/backfill_revert_response.rbi b/rbi/lib/orb/models/events/backfill_revert_response.rbi index bcdf8e21..a91055dd 100644 --- a/rbi/lib/orb/models/events/backfill_revert_response.rbi +++ b/rbi/lib/orb/models/events/backfill_revert_response.rbi @@ -110,7 +110,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillRevertResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol) } PENDING = T.let(:pending, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol) REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillRevertResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/invoice.rbi b/rbi/lib/orb/models/invoice.rbi index bf2e116c..bface1bf 100644 --- a/rbi/lib/orb/models/invoice.rbi +++ b/rbi/lib/orb/models/invoice.rbi @@ -746,7 +746,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol) } APPLIED_TO_INVOICE = T.let(:applied_to_invoice, Orb::Models::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol) @@ -805,7 +805,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol) } INCREMENT = T.let(:increment, Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol) DECREMENT = T.let(:decrement, Orb::Models::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol) @@ -959,7 +959,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::CustomerTaxID::Country) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol) } AD = T.let(:AD, Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::Invoice::CustomerTaxID::Country::TaggedSymbol) @@ -1049,7 +1050,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::CustomerTaxID::Type) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol) } AD_NRT = T.let(:ad_nrt, Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::Invoice::CustomerTaxID::Type::TaggedSymbol) @@ -1133,7 +1135,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::InvoiceSource) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Invoice::InvoiceSource::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::InvoiceSource::TaggedSymbol) } SUBSCRIPTION = T.let(:subscription, Orb::Models::Invoice::InvoiceSource::TaggedSymbol) PARTIAL = T.let(:partial, Orb::Models::Invoice::InvoiceSource::TaggedSymbol) @@ -2370,7 +2372,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol) } STRIPE = T.let(:stripe, Orb::Models::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol) @@ -2434,7 +2436,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Invoice::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Invoice::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Invoice::Status::TaggedSymbol) } ISSUED = T.let(:issued, Orb::Models::Invoice::Status::TaggedSymbol) PAID = T.let(:paid, Orb::Models::Invoice::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/invoice_create_params.rbi b/rbi/lib/orb/models/invoice_create_params.rbi index fba4e81d..c57bbcb3 100644 --- a/rbi/lib/orb/models/invoice_create_params.rbi +++ b/rbi/lib/orb/models/invoice_create_params.rbi @@ -202,7 +202,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceCreateParams::LineItem::ModelType::TaggedSymbol) } UNIT = T.let(:unit, Orb::Models::InvoiceCreateParams::LineItem::ModelType::TaggedSymbol) diff --git a/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi b/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi index da46d4e9..e2b3274b 100644 --- a/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +++ b/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi @@ -787,7 +787,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action::TaggedSymbol + ) + end APPLIED_TO_INVOICE = T.let( @@ -879,7 +885,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type::TaggedSymbol + ) + end INCREMENT = T.let( @@ -1048,7 +1060,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol) } AD = T.let(:AD, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol) AE = T.let(:AE, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol) @@ -1142,7 +1154,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol) } AD_NRT = T.let(:ad_nrt, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol) AE_TRN = T.let(:ae_trn, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol) @@ -1232,7 +1244,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol) } SUBSCRIPTION = T.let(:subscription, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol) @@ -2527,7 +2539,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider::TaggedSymbol + ) + end STRIPE = T.let(:stripe, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider::TaggedSymbol) @@ -2598,7 +2616,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol) } ISSUED = T.let(:issued, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol) PAID = T.let(:paid, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/invoice_list_params.rbi b/rbi/lib/orb/models/invoice_list_params.rbi index bba5b774..4f63de46 100644 --- a/rbi/lib/orb/models/invoice_list_params.rbi +++ b/rbi/lib/orb/models/invoice_list_params.rbi @@ -156,7 +156,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceListParams::DateType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) } DUE_DATE = T.let(:due_date, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) INVOICE_DATE = T.let(:invoice_date, Orb::Models::InvoiceListParams::DateType::TaggedSymbol) @@ -170,7 +170,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceListParams::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::InvoiceListParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceListParams::Status::TaggedSymbol) } DRAFT = T.let(:draft, Orb::Models::InvoiceListParams::Status::TaggedSymbol) ISSUED = T.let(:issued, Orb::Models::InvoiceListParams::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/item.rbi b/rbi/lib/orb/models/item.rbi index 0b883125..1d1aac80 100644 --- a/rbi/lib/orb/models/item.rbi +++ b/rbi/lib/orb/models/item.rbi @@ -79,7 +79,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) } STRIPE = T.let(:stripe, Orb::Models::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol) QUICKBOOKS = diff --git a/rbi/lib/orb/models/item_update_params.rbi b/rbi/lib/orb/models/item_update_params.rbi index 38506c97..67e0b803 100644 --- a/rbi/lib/orb/models/item_update_params.rbi +++ b/rbi/lib/orb/models/item_update_params.rbi @@ -71,7 +71,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol + ) + end STRIPE = T.let(:stripe, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol) diff --git a/rbi/lib/orb/models/percentage_discount.rbi b/rbi/lib/orb/models/percentage_discount.rbi index 22d3fde9..0f8e5f32 100644 --- a/rbi/lib/orb/models/percentage_discount.rbi +++ b/rbi/lib/orb/models/percentage_discount.rbi @@ -49,7 +49,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PercentageDiscount::DiscountType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::PercentageDiscount::DiscountType::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::PercentageDiscount::DiscountType::TaggedSymbol) } PERCENTAGE = T.let(:percentage, Orb::Models::PercentageDiscount::DiscountType::TaggedSymbol) diff --git a/rbi/lib/orb/models/plan.rbi b/rbi/lib/orb/models/plan.rbi index 4f57af94..533a6d87 100644 --- a/rbi/lib/orb/models/plan.rbi +++ b/rbi/lib/orb/models/plan.rbi @@ -932,7 +932,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::PlanPhase::DurationUnit) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) } DAILY = T.let(:daily, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) @@ -1011,7 +1012,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Plan::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Plan::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::Plan::Status::TaggedSymbol) ARCHIVED = T.let(:archived, Orb::Models::Plan::Status::TaggedSymbol) @@ -1055,7 +1056,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol) } DAYS = T.let(:days, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol) diff --git a/rbi/lib/orb/models/plan_create_params.rbi b/rbi/lib/orb/models/plan_create_params.rbi index d5e7fac8..a25b0a0c 100644 --- a/rbi/lib/orb/models/plan_create_params.rbi +++ b/rbi/lib/orb/models/plan_create_params.rbi @@ -366,7 +366,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence::TaggedSymbol) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -446,6 +446,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -523,6 +524,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -734,7 +736,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence::TaggedSymbol) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -823,6 +825,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -900,6 +903,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1111,7 +1115,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence::TaggedSymbol) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -1248,6 +1252,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1325,6 +1330,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1536,7 +1542,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence::TaggedSymbol) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -1655,6 +1661,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1732,6 +1739,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1947,7 +1955,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence::TaggedSymbol) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence::TaggedSymbol) @@ -2093,6 +2101,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2170,6 +2179,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2399,7 +2409,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence::TaggedSymbol) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -2464,6 +2474,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2541,6 +2552,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2808,7 +2820,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence::TaggedSymbol) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -2878,6 +2890,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2955,6 +2968,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3206,7 +3220,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence::TaggedSymbol) } ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence::TaggedSymbol) SEMI_ANNUAL = @@ -3272,6 +3286,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3349,6 +3364,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3571,6 +3587,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence::TaggedSymbol ) end @@ -3665,6 +3682,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3742,6 +3760,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3953,7 +3972,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence::TaggedSymbol + ) + end ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence::TaggedSymbol) @@ -4028,6 +4053,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4105,6 +4131,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4320,7 +4347,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence::TaggedSymbol + ) + end ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence::TaggedSymbol) @@ -4406,6 +4439,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4483,6 +4517,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4694,7 +4729,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence::TaggedSymbol + ) + end ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence::TaggedSymbol) @@ -4774,6 +4815,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4851,6 +4893,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5073,6 +5116,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence::TaggedSymbol ) end @@ -5167,6 +5211,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5244,6 +5289,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5459,7 +5505,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence::TaggedSymbol + ) + end ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence::TaggedSymbol) @@ -5545,6 +5597,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5622,6 +5675,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5837,7 +5891,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence::TaggedSymbol + ) + end ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence::TaggedSymbol) @@ -5923,6 +5983,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6000,6 +6061,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6215,7 +6277,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence::TaggedSymbol + ) + end ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence::TaggedSymbol) @@ -6301,6 +6369,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6378,6 +6447,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6600,6 +6670,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ) end @@ -6694,6 +6765,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6771,6 +6843,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6993,6 +7066,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ) end @@ -7087,6 +7161,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7164,6 +7239,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7386,6 +7462,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ) end @@ -7480,6 +7557,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7557,6 +7635,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7772,7 +7851,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence::TaggedSymbol + ) + end ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence::TaggedSymbol) @@ -7858,6 +7943,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7935,6 +8021,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8157,6 +8244,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -8251,6 +8339,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8328,6 +8417,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8550,6 +8640,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -8644,6 +8735,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8721,6 +8813,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8947,6 +9040,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ) end @@ -9041,6 +9135,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9118,6 +9213,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9344,6 +9440,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ) end @@ -9438,6 +9535,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9515,6 +9613,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9737,6 +9836,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ) end @@ -9831,6 +9931,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9908,6 +10009,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9953,7 +10055,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::PlanCreateParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::PlanCreateParams::Status::TaggedSymbol) DRAFT = T.let(:draft, Orb::Models::PlanCreateParams::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/plan_list_params.rbi b/rbi/lib/orb/models/plan_list_params.rbi index fd611c58..fed031a4 100644 --- a/rbi/lib/orb/models/plan_list_params.rbi +++ b/rbi/lib/orb/models/plan_list_params.rbi @@ -85,7 +85,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanListParams::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::PlanListParams::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::PlanListParams::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::PlanListParams::Status::TaggedSymbol) ARCHIVED = T.let(:archived, Orb::Models::PlanListParams::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/price.rbi b/rbi/lib/orb/models/price.rbi index faaef769..a1c7f500 100644 --- a/rbi/lib/orb/models/price.rbi +++ b/rbi/lib/orb/models/price.rbi @@ -309,7 +309,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::UnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -328,7 +334,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::UnitPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::UnitPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::UnitPrice::Cadence::TaggedSymbol) @@ -393,7 +399,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::UnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -470,7 +482,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::UnitPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::UnitPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::UnitPrice::PriceType::TaggedSymbol) @@ -810,7 +822,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::PackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -830,7 +848,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackagePrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::PackagePrice::Cadence::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::PackagePrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::PackagePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::PackagePrice::Cadence::TaggedSymbol) @@ -895,7 +914,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::PackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -994,7 +1019,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackagePrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::PackagePrice::PriceType::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::PackagePrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::PackagePrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::PackagePrice::PriceType::TaggedSymbol) @@ -1320,7 +1346,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::MatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -1339,7 +1371,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::MatrixPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::MatrixPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::MatrixPrice::Cadence::TaggedSymbol) @@ -1404,7 +1436,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::MatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -1547,7 +1585,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::MatrixPrice::PriceType::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::MatrixPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::MatrixPrice::PriceType::TaggedSymbol) @@ -1873,7 +1912,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::TieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -1892,7 +1937,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::TieredPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredPrice::Cadence::TaggedSymbol) @@ -1957,7 +2002,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::TieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -2037,7 +2088,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::TieredPrice::PriceType::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredPrice::PriceType::TaggedSymbol) @@ -2411,7 +2463,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::TieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -2433,7 +2491,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredBpsPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::TieredBpsPrice::Cadence::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredBpsPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredBpsPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredBpsPrice::Cadence::TaggedSymbol) @@ -2498,7 +2557,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::TieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -2578,7 +2643,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredBpsPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::TieredBpsPrice::PriceType::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredBpsPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredBpsPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredBpsPrice::PriceType::TaggedSymbol) @@ -2968,7 +3034,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } DAY = T.let(:day, Orb::Models::Price::BpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -3005,7 +3071,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BpsPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::BpsPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::BpsPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::BpsPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::BpsPrice::Cadence::TaggedSymbol) @@ -3070,7 +3136,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::BpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -3147,7 +3219,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BpsPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::BpsPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::BpsPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::BpsPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BpsPrice::PriceType::TaggedSymbol) @@ -3473,7 +3545,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::BulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -3544,7 +3622,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkBpsPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::BulkBpsPrice::Cadence::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkBpsPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::BulkBpsPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::BulkBpsPrice::Cadence::TaggedSymbol) @@ -3609,7 +3688,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::BulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) @@ -3689,7 +3774,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkBpsPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::BulkBpsPrice::PriceType::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkBpsPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::BulkBpsPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BulkBpsPrice::PriceType::TaggedSymbol) @@ -4015,7 +4101,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::BulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -4069,7 +4161,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::BulkPrice::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::BulkPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::BulkPrice::Cadence::TaggedSymbol) @@ -4134,7 +4226,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::Price::BulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -4211,7 +4309,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkPrice::PriceType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::BulkPrice::PriceType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::BulkPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BulkPrice::PriceType::TaggedSymbol) @@ -4559,6 +4657,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::ThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4590,7 +4689,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::ThresholdTotalAmountPrice::Cadence::TaggedSymbol) @@ -4662,6 +4761,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::ThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4751,7 +4851,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::ThresholdTotalAmountPrice::PriceType::TaggedSymbol) @@ -5081,6 +5181,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::TieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5108,7 +5209,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackagePrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::TieredPackagePrice::Cadence::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPackagePrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredPackagePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredPackagePrice::Cadence::TaggedSymbol) @@ -5176,6 +5278,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::TieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5265,7 +5368,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackagePrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredPackagePrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPackagePrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredPackagePrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredPackagePrice::PriceType::TaggedSymbol) @@ -5595,6 +5698,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5622,7 +5726,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPrice::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedTieredPrice::Cadence::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedTieredPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedTieredPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedTieredPrice::Cadence::TaggedSymbol) @@ -5690,6 +5795,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5779,7 +5885,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedTieredPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedTieredPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedTieredPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::GroupedTieredPrice::PriceType::TaggedSymbol) @@ -6119,6 +6225,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::TieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6150,7 +6257,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithMinimumPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredWithMinimumPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredWithMinimumPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredWithMinimumPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredWithMinimumPrice::Cadence::TaggedSymbol) @@ -6222,6 +6329,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::TieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6311,7 +6419,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithMinimumPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredWithMinimumPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredWithMinimumPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredWithMinimumPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredWithMinimumPrice::PriceType::TaggedSymbol) @@ -6665,6 +6773,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::TieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6696,7 +6805,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredPackageWithMinimumPrice::Cadence::TaggedSymbol) @@ -6771,6 +6880,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::TieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6861,7 +6971,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredPackageWithMinimumPrice::PriceType::TaggedSymbol) @@ -7211,6 +7321,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::PackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7242,7 +7353,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackageWithAllocationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::PackageWithAllocationPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::PackageWithAllocationPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::PackageWithAllocationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::PackageWithAllocationPrice::Cadence::TaggedSymbol) @@ -7314,6 +7425,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::PackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7403,7 +7515,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::PackageWithAllocationPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::PackageWithAllocationPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::PackageWithAllocationPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::PackageWithAllocationPrice::PriceType::TaggedSymbol) @@ -7745,6 +7857,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::UnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7776,7 +7889,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithPercentPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::UnitWithPercentPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitWithPercentPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::UnitWithPercentPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::UnitWithPercentPrice::Cadence::TaggedSymbol) @@ -7844,6 +7957,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::UnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7933,7 +8047,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithPercentPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::UnitWithPercentPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitWithPercentPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::UnitWithPercentPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::UnitWithPercentPrice::PriceType::TaggedSymbol) @@ -8289,6 +8403,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::MatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8320,7 +8435,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithAllocationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::MatrixWithAllocationPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixWithAllocationPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::MatrixWithAllocationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::MatrixWithAllocationPrice::Cadence::TaggedSymbol) @@ -8392,6 +8507,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::MatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8555,7 +8671,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithAllocationPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::MatrixWithAllocationPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixWithAllocationPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::MatrixWithAllocationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::MatrixWithAllocationPrice::PriceType::TaggedSymbol) @@ -8903,6 +9019,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::TieredWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8934,7 +9051,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithProrationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredWithProrationPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredWithProrationPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::TieredWithProrationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::TieredWithProrationPrice::Cadence::TaggedSymbol) @@ -9006,6 +9123,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::TieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9095,7 +9213,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::TieredWithProrationPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::TieredWithProrationPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::TieredWithProrationPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::TieredWithProrationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::TieredWithProrationPrice::PriceType::TaggedSymbol) @@ -9435,6 +9553,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::UnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9466,7 +9585,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithProrationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::UnitWithProrationPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitWithProrationPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::UnitWithProrationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::UnitWithProrationPrice::Cadence::TaggedSymbol) @@ -9538,6 +9657,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::UnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9627,7 +9747,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::UnitWithProrationPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::UnitWithProrationPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::UnitWithProrationPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::UnitWithProrationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::UnitWithProrationPrice::PriceType::TaggedSymbol) @@ -9967,6 +10087,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9998,7 +10119,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedAllocationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedAllocationPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedAllocationPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedAllocationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedAllocationPrice::Cadence::TaggedSymbol) @@ -10070,6 +10191,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10159,7 +10281,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedAllocationPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedAllocationPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedAllocationPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedAllocationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::GroupedAllocationPrice::PriceType::TaggedSymbol) @@ -10525,6 +10647,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10557,7 +10680,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedWithProratedMinimumPrice::Cadence::TaggedSymbol) @@ -10632,6 +10755,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10724,7 +10848,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedWithProratedMinimumPrice::PriceType::TaggedSymbol) @@ -11080,6 +11204,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11112,7 +11237,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol) @@ -11187,6 +11312,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11279,7 +11405,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedWithMeteredMinimumPrice::PriceType::TaggedSymbol) @@ -11629,6 +11755,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::MatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11660,7 +11787,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::MatrixWithDisplayNamePrice::Cadence::TaggedSymbol) @@ -11732,6 +11859,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::MatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11821,7 +11949,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::MatrixWithDisplayNamePrice::PriceType::TaggedSymbol) @@ -12163,6 +12291,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::BulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -12194,7 +12323,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkWithProrationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::BulkWithProrationPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkWithProrationPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::BulkWithProrationPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::BulkWithProrationPrice::Cadence::TaggedSymbol) @@ -12266,6 +12395,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::BulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -12355,7 +12485,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::BulkWithProrationPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::BulkWithProrationPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::BulkWithProrationPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::BulkWithProrationPrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::BulkWithProrationPrice::PriceType::TaggedSymbol) @@ -12703,6 +12833,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -12734,7 +12865,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPackagePrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedTieredPackagePrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedTieredPackagePrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::GroupedTieredPackagePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::GroupedTieredPackagePrice::Cadence::TaggedSymbol) @@ -12806,6 +12937,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::GroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -12895,7 +13027,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::GroupedTieredPackagePrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::GroupedTieredPackagePrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::GroupedTieredPackagePrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::GroupedTieredPackagePrice::PriceType::TaggedSymbol) FIXED_PRICE = T.let(:fixed_price, Orb::Models::Price::GroupedTieredPackagePrice::PriceType::TaggedSymbol) @@ -13243,6 +13375,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::MaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13274,7 +13407,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::MaxGroupTieredPackagePrice::Cadence::TaggedSymbol) @@ -13346,6 +13479,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::MaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13435,7 +13569,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::MaxGroupTieredPackagePrice::PriceType::TaggedSymbol) @@ -13813,6 +13947,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13847,7 +13982,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol) @@ -13924,6 +14059,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14016,7 +14152,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice::PriceType::TaggedSymbol) @@ -14403,6 +14539,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14437,7 +14574,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol) @@ -14517,6 +14654,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14609,7 +14747,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice::PriceType::TaggedSymbol) @@ -14962,6 +15100,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::CumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14993,7 +15132,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence::TaggedSymbol) } ONE_TIME = T.let(:one_time, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence::TaggedSymbol) MONTHLY = T.let(:monthly, Orb::Models::Price::CumulativeGroupedBulkPrice::Cadence::TaggedSymbol) @@ -15065,6 +15204,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::Price::CumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15154,7 +15294,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType::TaggedSymbol) } USAGE_PRICE = T.let(:usage_price, Orb::Models::Price::CumulativeGroupedBulkPrice::PriceType::TaggedSymbol) diff --git a/rbi/lib/orb/models/price_create_params.rbi b/rbi/lib/orb/models/price_create_params.rbi index b467e67c..6624ceb0 100644 --- a/rbi/lib/orb/models/price_create_params.rbi +++ b/rbi/lib/orb/models/price_create_params.rbi @@ -353,7 +353,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::Cadence) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol) } ANNUAL = T.let(:annual, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol) SEMI_ANNUAL = T.let(:semi_annual, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol) @@ -371,7 +371,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::ModelType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::PriceCreateParams::ModelType::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::PriceCreateParams::ModelType::TaggedSymbol) } CUMULATIVE_GROUPED_BULK = T.let(:cumulative_grouped_bulk, Orb::Models::PriceCreateParams::ModelType::TaggedSymbol) @@ -435,7 +436,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol) MONTH = @@ -490,7 +497,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol + ) + end DAY = T.let(:day, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription.rbi b/rbi/lib/orb/models/subscription.rbi index 9767e885..c5b987b3 100644 --- a/rbi/lib/orb/models/subscription.rbi +++ b/rbi/lib/orb/models/subscription.rbi @@ -1353,7 +1353,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Subscription::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::Subscription::Status::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Subscription::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::Subscription::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::Subscription::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_cancel_params.rbi b/rbi/lib/orb/models/subscription_cancel_params.rbi index b277ed55..643b05b5 100644 --- a/rbi/lib/orb/models/subscription_cancel_params.rbi +++ b/rbi/lib/orb/models/subscription_cancel_params.rbi @@ -58,7 +58,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCancelParams::CancelOption) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionCancelParams::CancelOption::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionCancelParams::CancelOption::TaggedSymbol) } END_OF_SUBSCRIPTION_TERM = T.let(:end_of_subscription_term, Orb::Models::SubscriptionCancelParams::CancelOption::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_cancel_response.rbi b/rbi/lib/orb/models/subscription_cancel_response.rbi index 9574630c..bd169ca6 100644 --- a/rbi/lib/orb/models/subscription_cancel_response.rbi +++ b/rbi/lib/orb/models/subscription_cancel_response.rbi @@ -1345,7 +1345,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCancelResponse::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionCancelResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_create_params.rbi b/rbi/lib/orb/models/subscription_create_params.rbi index f3674b9a..639dc3bc 100644 --- a/rbi/lib/orb/models/subscription_create_params.rbi +++ b/rbi/lib/orb/models/subscription_create_params.rbi @@ -873,7 +873,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence::TaggedSymbol + ) + end ONE_TIME = T.let(:one_time, Orb::Models::SubscriptionCreateParams::AddPrice::AllocationPrice::Cadence::TaggedSymbol) @@ -950,7 +956,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType::TaggedSymbol + ) + end PERCENTAGE = T.let(:percentage, Orb::Models::SubscriptionCreateParams::AddPrice::Discount::DiscountType::TaggedSymbol) @@ -1191,6 +1203,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol ) end @@ -1299,6 +1312,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1376,6 +1390,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1630,6 +1645,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol ) end @@ -1743,6 +1759,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1820,6 +1837,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2068,6 +2086,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol ) end @@ -2238,6 +2257,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2315,6 +2335,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2563,6 +2584,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol ) end @@ -2722,6 +2744,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2799,6 +2822,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3053,6 +3077,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol ) end @@ -3233,6 +3258,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3310,6 +3336,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3576,6 +3603,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol ) end @@ -3670,6 +3698,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3747,6 +3776,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4070,6 +4100,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol ) end @@ -4164,6 +4195,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4241,6 +4273,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4542,6 +4575,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol ) end @@ -4636,6 +4670,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4713,6 +4748,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4949,6 +4985,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol ) end @@ -5045,6 +5082,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5122,6 +5160,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5358,6 +5397,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -5454,6 +5494,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5531,6 +5572,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5767,6 +5809,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol ) end @@ -5863,6 +5906,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5940,6 +5984,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6176,6 +6221,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol ) end @@ -6272,6 +6318,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6349,6 +6396,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6585,6 +6633,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol ) end @@ -6681,6 +6730,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6758,6 +6808,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6994,6 +7045,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol ) end @@ -7090,6 +7142,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7167,6 +7220,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7403,6 +7457,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol ) end @@ -7499,6 +7554,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7576,6 +7632,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7812,6 +7869,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol ) end @@ -7908,6 +7966,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7985,6 +8044,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8221,6 +8281,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ) end @@ -8317,6 +8378,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8394,6 +8456,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8630,6 +8693,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol ) end @@ -8726,6 +8790,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8803,6 +8868,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9039,6 +9105,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ) end @@ -9135,6 +9202,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9212,6 +9280,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9448,6 +9517,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ) end @@ -9544,6 +9614,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9621,6 +9692,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9857,6 +9929,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ) end @@ -9953,6 +10026,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10030,6 +10104,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10266,6 +10341,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -10362,6 +10438,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10439,6 +10516,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10675,6 +10753,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ) end @@ -10771,6 +10850,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10848,6 +10928,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11084,6 +11165,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ) end @@ -11180,6 +11262,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11257,6 +11340,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11493,6 +11577,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -11589,6 +11674,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11666,6 +11752,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11741,7 +11828,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::ExternalMarketplace) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionCreateParams::ExternalMarketplace::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionCreateParams::ExternalMarketplace::TaggedSymbol) } GOOGLE = T.let(:google, Orb::Models::SubscriptionCreateParams::ExternalMarketplace::TaggedSymbol) AWS = T.let(:aws, Orb::Models::SubscriptionCreateParams::ExternalMarketplace::TaggedSymbol) @@ -12355,7 +12442,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::SubscriptionCreateParams::ReplacePrice::AllocationPrice::Cadence::TaggedSymbol + ) + end ONE_TIME = T.let( @@ -12449,7 +12542,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount::DiscountType) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount::DiscountType::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::SubscriptionCreateParams::ReplacePrice::Discount::DiscountType::TaggedSymbol + ) + end PERCENTAGE = T.let( @@ -12697,6 +12796,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol ) end @@ -12807,6 +12907,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -12884,6 +12985,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13138,6 +13240,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol ) end @@ -13253,6 +13356,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13330,6 +13434,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13584,6 +13689,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol ) end @@ -13756,6 +13862,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13833,6 +13940,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14087,6 +14195,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol ) end @@ -14248,6 +14357,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14325,6 +14435,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14579,6 +14690,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol ) end @@ -14759,6 +14871,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14836,6 +14949,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15104,6 +15218,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol ) end @@ -15198,6 +15313,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15275,6 +15391,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15602,6 +15719,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol ) end @@ -15698,6 +15816,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15775,6 +15894,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -16078,6 +16198,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol ) end @@ -16174,6 +16295,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -16251,6 +16373,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -16487,6 +16610,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol ) end @@ -16583,6 +16707,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -16660,6 +16785,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -16896,6 +17022,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -16992,6 +17119,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17069,6 +17197,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17305,6 +17434,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol ) end @@ -17401,6 +17531,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17478,6 +17609,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17714,6 +17846,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol ) end @@ -17810,6 +17943,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17887,6 +18021,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18123,6 +18258,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol ) end @@ -18219,6 +18355,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18296,6 +18433,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18532,6 +18670,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol ) end @@ -18628,6 +18767,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18705,6 +18845,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18941,6 +19082,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol ) end @@ -19037,6 +19179,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19114,6 +19257,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19350,6 +19494,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol ) end @@ -19446,6 +19591,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19523,6 +19669,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19759,6 +19906,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ) end @@ -19855,6 +20003,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19932,6 +20081,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20168,6 +20318,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol ) end @@ -20264,6 +20415,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20341,6 +20493,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20577,6 +20730,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ) end @@ -20673,6 +20827,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20750,6 +20905,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20986,6 +21142,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ) end @@ -21082,6 +21239,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21159,6 +21317,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21395,6 +21554,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ) end @@ -21491,6 +21651,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21568,6 +21729,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21804,6 +21966,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -21900,6 +22063,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21977,6 +22141,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -22213,6 +22378,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ) end @@ -22309,6 +22475,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -22386,6 +22553,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -22622,6 +22790,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ) end @@ -22718,6 +22887,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -22795,6 +22965,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -23031,6 +23202,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -23127,6 +23299,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -23204,6 +23377,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end diff --git a/rbi/lib/orb/models/subscription_create_response.rbi b/rbi/lib/orb/models/subscription_create_response.rbi index 30113fa3..9b39e582 100644 --- a/rbi/lib/orb/models/subscription_create_response.rbi +++ b/rbi/lib/orb/models/subscription_create_response.rbi @@ -1345,7 +1345,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateResponse::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_fetch_costs_params.rbi b/rbi/lib/orb/models/subscription_fetch_costs_params.rbi index a9aa38a9..98a72181 100644 --- a/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_costs_params.rbi @@ -68,7 +68,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol) } PERIODIC = T.let(:periodic, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol) CUMULATIVE = T.let(:cumulative, Orb::Models::SubscriptionFetchCostsParams::ViewMode::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_fetch_usage_params.rbi b/rbi/lib/orb/models/subscription_fetch_usage_params.rbi index 7f525d2a..d5f4cb11 100644 --- a/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +++ b/rbi/lib/orb/models/subscription_fetch_usage_params.rbi @@ -105,7 +105,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionFetchUsageParams::Granularity::TaggedSymbol) } DAY = T.let(:day, Orb::Models::SubscriptionFetchUsageParams::Granularity::TaggedSymbol) @@ -123,7 +123,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol) } PERIODIC = T.let(:periodic, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol) CUMULATIVE = T.let(:cumulative, Orb::Models::SubscriptionFetchUsageParams::ViewMode::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_list_params.rbi b/rbi/lib/orb/models/subscription_list_params.rbi index 4c3dd676..52141708 100644 --- a/rbi/lib/orb/models/subscription_list_params.rbi +++ b/rbi/lib/orb/models/subscription_list_params.rbi @@ -92,7 +92,8 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionListParams::Status) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::SubscriptionListParams::Status::TaggedSymbol) } + OrSymbol = + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionListParams::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionListParams::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionListParams::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_price_intervals_params.rbi b/rbi/lib/orb/models/subscription_price_intervals_params.rbi index b3c572a9..e9285bbb 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_params.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_params.rbi @@ -407,7 +407,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence::TaggedSymbol + ) + end ONE_TIME = T.let( @@ -753,6 +759,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::Cadence::TaggedSymbol ) end @@ -861,6 +868,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -938,6 +946,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1177,6 +1186,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::Cadence::TaggedSymbol ) end @@ -1290,6 +1300,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1367,6 +1378,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1606,6 +1618,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::Cadence::TaggedSymbol ) end @@ -1776,6 +1789,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1853,6 +1867,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2098,6 +2113,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence::TaggedSymbol ) end @@ -2276,6 +2292,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2353,6 +2370,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2592,6 +2610,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::Cadence::TaggedSymbol ) end @@ -2751,6 +2770,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2828,6 +2848,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3073,6 +3094,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence::TaggedSymbol ) end @@ -3253,6 +3275,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3330,6 +3353,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3583,6 +3607,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::Cadence::TaggedSymbol ) end @@ -3677,6 +3702,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3754,6 +3780,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4062,6 +4089,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::Cadence::TaggedSymbol ) end @@ -4156,6 +4184,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4233,6 +4262,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4525,6 +4555,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::Cadence::TaggedSymbol ) end @@ -4619,6 +4650,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4696,6 +4728,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4923,6 +4956,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence::TaggedSymbol ) end @@ -5019,6 +5053,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5096,6 +5131,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5323,6 +5359,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -5419,6 +5456,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5496,6 +5534,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5723,6 +5762,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence::TaggedSymbol ) end @@ -5819,6 +5859,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5896,6 +5937,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6123,6 +6165,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -6219,6 +6262,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6296,6 +6340,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6523,6 +6568,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence::TaggedSymbol ) end @@ -6619,6 +6665,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6696,6 +6743,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6923,6 +6971,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence::TaggedSymbol ) end @@ -7019,6 +7068,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7096,6 +7146,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7323,6 +7374,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence::TaggedSymbol ) end @@ -7419,6 +7471,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7496,6 +7549,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7723,6 +7777,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence::TaggedSymbol ) end @@ -7819,6 +7874,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7896,6 +7952,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8123,6 +8180,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence::TaggedSymbol ) end @@ -8219,6 +8277,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8296,6 +8355,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8523,6 +8583,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence::TaggedSymbol ) end @@ -8619,6 +8680,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8696,6 +8758,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8923,6 +8986,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence::TaggedSymbol ) end @@ -9019,6 +9083,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9096,6 +9161,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9323,6 +9389,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ) end @@ -9419,6 +9486,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9496,6 +9564,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9723,6 +9792,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ) end @@ -9819,6 +9889,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9896,6 +9967,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10123,6 +10195,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ) end @@ -10219,6 +10292,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10296,6 +10370,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10523,6 +10598,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence::TaggedSymbol ) end @@ -10619,6 +10695,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10696,6 +10773,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10923,6 +11001,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -11019,6 +11098,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11096,6 +11176,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11323,6 +11404,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ) end @@ -11419,6 +11501,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11496,6 +11579,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11723,6 +11807,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ) end @@ -11819,6 +11904,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11896,6 +11982,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -12123,6 +12210,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ) end @@ -12219,6 +12307,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -12296,6 +12385,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end diff --git a/rbi/lib/orb/models/subscription_price_intervals_response.rbi b/rbi/lib/orb/models/subscription_price_intervals_response.rbi index 0d4288a6..e56d94b6 100644 --- a/rbi/lib/orb/models/subscription_price_intervals_response.rbi +++ b/rbi/lib/orb/models/subscription_price_intervals_response.rbi @@ -1359,7 +1359,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionPriceIntervalsResponse::Status::TaggedSymbol) 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 d666f06e..65138878 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi @@ -276,7 +276,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption::TaggedSymbol) } REQUESTED_DATE = T.let(:requested_date, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption::TaggedSymbol) @@ -895,6 +895,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::AllocationPrice::Cadence::TaggedSymbol ) end @@ -994,6 +995,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Discount::DiscountType::TaggedSymbol ) end @@ -1254,6 +1256,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol ) end @@ -1364,6 +1367,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1441,6 +1445,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1695,6 +1700,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol ) end @@ -1810,6 +1816,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -1887,6 +1894,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2141,6 +2149,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol ) end @@ -2313,6 +2322,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2390,6 +2400,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2644,6 +2655,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol ) end @@ -2809,6 +2821,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -2886,6 +2899,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3140,6 +3154,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol ) end @@ -3320,6 +3335,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3397,6 +3413,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3669,6 +3686,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol ) end @@ -3765,6 +3783,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -3842,6 +3861,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4169,6 +4189,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol ) end @@ -4265,6 +4286,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4342,6 +4364,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4653,6 +4676,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol ) end @@ -4749,6 +4773,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -4826,6 +4851,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5062,6 +5088,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol ) end @@ -5158,6 +5185,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5235,6 +5263,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5471,6 +5500,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -5567,6 +5597,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5644,6 +5675,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -5880,6 +5912,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol ) end @@ -5976,6 +6009,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6053,6 +6087,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6289,6 +6324,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol ) end @@ -6385,6 +6421,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6462,6 +6499,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6698,6 +6736,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol ) end @@ -6794,6 +6833,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -6871,6 +6911,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7107,6 +7148,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol ) end @@ -7203,6 +7245,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7280,6 +7323,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7516,6 +7560,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol ) end @@ -7612,6 +7657,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7689,6 +7735,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -7925,6 +7972,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol ) end @@ -8021,6 +8069,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8098,6 +8147,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8334,6 +8384,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ) end @@ -8430,6 +8481,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8507,6 +8559,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8743,6 +8796,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol ) end @@ -8839,6 +8893,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -8916,6 +8971,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9152,6 +9208,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ) end @@ -9248,6 +9305,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9325,6 +9383,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9561,6 +9620,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ) end @@ -9657,6 +9717,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9734,6 +9795,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -9970,6 +10032,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ) end @@ -10066,6 +10129,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10143,6 +10207,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10379,6 +10444,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -10475,6 +10541,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10552,6 +10619,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10788,6 +10856,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ) end @@ -10884,6 +10953,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -10961,6 +11031,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11197,6 +11268,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ) end @@ -11293,6 +11365,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11370,6 +11443,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11606,6 +11680,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -11702,6 +11777,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11779,6 +11855,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -11828,7 +11905,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::TaggedSymbol + ) + end UNCHANGED = T.let(:unchanged, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::TaggedSymbol) @@ -12501,6 +12584,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::AllocationPrice::Cadence::TaggedSymbol ) end @@ -12600,6 +12684,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Discount::DiscountType::TaggedSymbol ) end @@ -12860,6 +12945,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::Cadence::TaggedSymbol ) end @@ -12970,6 +13056,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13047,6 +13134,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13301,6 +13389,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::Cadence::TaggedSymbol ) end @@ -13416,6 +13505,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13493,6 +13583,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13747,6 +13838,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::Cadence::TaggedSymbol ) end @@ -13919,6 +14011,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -13996,6 +14089,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14250,6 +14344,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::Cadence::TaggedSymbol ) end @@ -14415,6 +14510,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14492,6 +14588,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -14746,6 +14843,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::Cadence::TaggedSymbol ) end @@ -14926,6 +15024,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15003,6 +15102,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15275,6 +15375,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::Cadence::TaggedSymbol ) end @@ -15371,6 +15472,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15448,6 +15550,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15775,6 +15878,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::Cadence::TaggedSymbol ) end @@ -15871,6 +15975,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -15948,6 +16053,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -16259,6 +16365,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::Cadence::TaggedSymbol ) end @@ -16355,6 +16462,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -16432,6 +16540,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -16668,6 +16777,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::Cadence::TaggedSymbol ) end @@ -16764,6 +16874,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -16841,6 +16952,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17077,6 +17189,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -17173,6 +17286,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17250,6 +17364,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17486,6 +17601,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::Cadence::TaggedSymbol ) end @@ -17582,6 +17698,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17659,6 +17776,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -17895,6 +18013,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::Cadence::TaggedSymbol ) end @@ -17991,6 +18110,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18068,6 +18188,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18304,6 +18425,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::Cadence::TaggedSymbol ) end @@ -18400,6 +18522,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18477,6 +18600,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18713,6 +18837,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::Cadence::TaggedSymbol ) end @@ -18809,6 +18934,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -18886,6 +19012,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19122,6 +19249,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::Cadence::TaggedSymbol ) end @@ -19218,6 +19346,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19295,6 +19424,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19531,6 +19661,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::Cadence::TaggedSymbol ) end @@ -19627,6 +19758,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19704,6 +19836,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -19940,6 +20073,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol ) end @@ -20036,6 +20170,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20113,6 +20248,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20349,6 +20485,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::Cadence::TaggedSymbol ) end @@ -20445,6 +20582,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20522,6 +20660,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20758,6 +20897,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol ) end @@ -20854,6 +20994,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -20931,6 +21072,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21167,6 +21309,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol ) end @@ -21263,6 +21406,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21340,6 +21484,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21576,6 +21721,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::Cadence::TaggedSymbol ) end @@ -21672,6 +21818,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21749,6 +21896,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -21985,6 +22133,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -22081,6 +22230,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -22158,6 +22308,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -22394,6 +22545,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol ) end @@ -22490,6 +22642,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -22567,6 +22720,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -22803,6 +22957,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::Cadence::TaggedSymbol ) end @@ -22899,6 +23054,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -22976,6 +23132,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -23212,6 +23369,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::Cadence::TaggedSymbol ) end @@ -23308,6 +23466,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol ) end @@ -23385,6 +23544,7 @@ module Orb T.type_alias do T.any( Symbol, + String, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::NewSubscriptionGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol ) 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 ce83a93f..6137ce9a 100644 --- a/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +++ b/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi @@ -1362,7 +1362,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi index 79e30145..c5177194 100644 --- a/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +++ b/rbi/lib/orb/models/subscription_trigger_phase_response.rbi @@ -1353,7 +1353,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi index 61ef3e1f..743d00cc 100644 --- a/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +++ b/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi @@ -1371,7 +1371,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol) 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 eab1cd00..9e3e0570 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 @@ -1409,7 +1409,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status::TaggedSymbol + ) + end ACTIVE = T.let(:active, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status::TaggedSymbol) 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 df1cf4ca..f9b2617d 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 @@ -1376,7 +1376,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::Status::TaggedSymbol) 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 e0957839..f52b6fec 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 @@ -80,7 +80,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption::TaggedSymbol) } IMMEDIATE = T.let(:immediate, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi b/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi index 4d1bfde3..eb593c30 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 @@ -1371,7 +1371,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_update_trial_params.rbi b/rbi/lib/orb/models/subscription_update_trial_params.rbi index b0ae6889..524c04c3 100644 --- a/rbi/lib/orb/models/subscription_update_trial_params.rbi +++ b/rbi/lib/orb/models/subscription_update_trial_params.rbi @@ -54,7 +54,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::TaggedSymbol) } IMMEDIATE = T.let(:immediate, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::TaggedSymbol) end diff --git a/rbi/lib/orb/models/subscription_update_trial_response.rbi b/rbi/lib/orb/models/subscription_update_trial_response.rbi index 45ed1755..0d8ab47c 100644 --- a/rbi/lib/orb/models/subscription_update_trial_response.rbi +++ b/rbi/lib/orb/models/subscription_update_trial_response.rbi @@ -1350,7 +1350,7 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUpdateTrialResponse::Status) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol) } + T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol) } ACTIVE = T.let(:active, Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol) ENDED = T.let(:ended, Orb::Models::SubscriptionUpdateTrialResponse::Status::TaggedSymbol) diff --git a/rbi/lib/orb/models/subscription_usage.rbi b/rbi/lib/orb/models/subscription_usage.rbi index b5879274..8e82273e 100644 --- a/rbi/lib/orb/models/subscription_usage.rbi +++ b/rbi/lib/orb/models/subscription_usage.rbi @@ -113,7 +113,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol + ) + end PERIODIC = T.let(:periodic, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol) @@ -281,7 +287,13 @@ module Orb TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode) } OrSymbol = - T.type_alias { T.any(Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol) } + T.type_alias do + T.any( + Symbol, + String, + Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol + ) + end PERIODIC = T.let(:periodic, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode::TaggedSymbol) diff --git a/rbi/lib/orb/models/trial_discount.rbi b/rbi/lib/orb/models/trial_discount.rbi index 88de8948..dc86f7d8 100644 --- a/rbi/lib/orb/models/trial_discount.rbi +++ b/rbi/lib/orb/models/trial_discount.rbi @@ -60,7 +60,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::TrialDiscount::DiscountType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::TrialDiscount::DiscountType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::TrialDiscount::DiscountType::TaggedSymbol) } TRIAL = T.let(:trial, Orb::Models::TrialDiscount::DiscountType::TaggedSymbol) diff --git a/rbi/lib/orb/models/usage_discount.rbi b/rbi/lib/orb/models/usage_discount.rbi index bd772653..e5f32240 100644 --- a/rbi/lib/orb/models/usage_discount.rbi +++ b/rbi/lib/orb/models/usage_discount.rbi @@ -49,7 +49,7 @@ module Orb extend Orb::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::UsageDiscount::DiscountType) } - OrSymbol = T.type_alias { T.any(Symbol, Orb::Models::UsageDiscount::DiscountType::TaggedSymbol) } + OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::UsageDiscount::DiscountType::TaggedSymbol) } USAGE = T.let(:usage, Orb::Models::UsageDiscount::DiscountType::TaggedSymbol) From 59fb348f33a4379778338d4f1791707713627a1e Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 1 Apr 2025 23:56:15 +0000 Subject: [PATCH 6/8] chore: order client variables by "importance" (#200) --- lib/orb/client.rb | 8 ++++---- rbi/lib/orb/client.rbi | 6 +++--- sig/orb/client.rbs | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/orb/client.rb b/lib/orb/client.rb index 257da5d5..bd46f2c0 100644 --- a/lib/orb/client.rb +++ b/lib/orb/client.rb @@ -71,10 +71,10 @@ class Client < Orb::Transport::BaseClient # Creates and returns a new client for interacting with the API. # - # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"` - # # @param api_key [String, nil] Defaults to `ENV["ORB_API_KEY"]` # + # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"` + # # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request. # # @param timeout [Float] @@ -85,8 +85,8 @@ class Client < Orb::Transport::BaseClient # # @param idempotency_header [String] def initialize( - base_url: nil, api_key: ENV["ORB_API_KEY"], + base_url: nil, max_retries: DEFAULT_MAX_RETRIES, timeout: DEFAULT_TIMEOUT_IN_SECONDS, initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY, @@ -96,7 +96,7 @@ def initialize( base_url ||= "https://api.withorb.com/v1" if api_key.nil? - raise ArgumentError.new("api_key is required") + raise ArgumentError.new("api_key is required, and can be set via environ: \"ORB_API_KEY\"") end @api_key = api_key.to_s diff --git a/rbi/lib/orb/client.rbi b/rbi/lib/orb/client.rbi index 0612ed96..e6f8d3b1 100644 --- a/rbi/lib/orb/client.rbi +++ b/rbi/lib/orb/client.rbi @@ -63,8 +63,8 @@ module Orb # Creates and returns a new client for interacting with the API. sig do params( - base_url: T.nilable(String), api_key: T.nilable(String), + base_url: T.nilable(String), max_retries: Integer, timeout: Float, initial_retry_delay: Float, @@ -74,10 +74,10 @@ module Orb .returns(T.attached_class) end def self.new( - # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"` - base_url: nil, # Defaults to `ENV["ORB_API_KEY"]` api_key: ENV["ORB_API_KEY"], + # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"` + base_url: nil, # Max number of retries to attempt after a failed retryable request. max_retries: DEFAULT_MAX_RETRIES, timeout: DEFAULT_TIMEOUT_IN_SECONDS, diff --git a/sig/orb/client.rbs b/sig/orb/client.rbs index 08dfc8a8..62947636 100644 --- a/sig/orb/client.rbs +++ b/sig/orb/client.rbs @@ -41,8 +41,8 @@ module Orb private def auth_headers: -> ::Hash[String, String] def initialize: ( - ?base_url: String?, ?api_key: String?, + ?base_url: String?, ?max_retries: Integer, ?timeout: Float, ?initial_retry_delay: Float, From 641222f1f19b2e4d14e7eabe8f9b4ef429fe02e9 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 2 Apr 2025 13:39:04 +0000 Subject: [PATCH 7/8] chore(internal): codegen related update (#201) --- .rubocop.yml | 3 +- README.md | 4 +- lib/orb/errors.rb | 499 ++++++++++++---------- lib/orb/transport/base_client.rb | 18 +- lib/orb/transport/pooled_net_requester.rb | 2 +- lib/orb/type/base_model.rb | 10 + lib/orb/type/base_page.rb | 2 +- lib/orb/util.rb | 16 +- rbi/lib/orb/errors.rbi | 356 ++++++++------- rbi/lib/orb/transport/base_client.rbi | 5 +- rbi/lib/orb/type/base_model.rbi | 8 + rbi/lib/orb/util.rbi | 4 +- sig/orb/errors.rbs | 286 +++++++------ sig/orb/transport/base_client.rbs | 2 +- sig/orb/type/base_model.rbs | 4 + sig/orb/util.rbs | 4 +- test/orb/base_model_test.rb | 2 +- test/orb/client_test.rb | 8 +- test/orb/util_test.rb | 2 +- 19 files changed, 675 insertions(+), 560 deletions(-) diff --git a/.rubocop.yml b/.rubocop.yml index 985ef56a..d434a478 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -127,8 +127,7 @@ Naming/ClassAndModuleCamelCase: - "**/*.rbi" Naming/MethodParameterName: - Exclude: - - "**/*.rbi" + Enabled: false Naming/PredicateName: Exclude: diff --git a/README.md b/README.md index 9600770a..5838b483 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ When the library is unable to connect to the API, or if the API returns a non-su ```ruby begin customer = orb.customers.create(email: "example-customer@withorb.com", name: "My Customer") -rescue Orb::Error => e +rescue Orb::Errors::APIError => e puts(e.status) # 400 end ``` @@ -79,7 +79,7 @@ Error codes are as followed: | HTTP 409 | `ConflictError` | | HTTP 422 | `UnprocessableEntityError` | | HTTP 429 | `RateLimitError` | -| HTTP >=500 | `InternalServerError` | +| HTTP >= 500 | `InternalServerError` | | Other HTTP error | `APIStatusError` | | Timeout | `APITimeoutError` | | Network error | `APIConnectionError` | diff --git a/lib/orb/errors.rb b/lib/orb/errors.rb index f936fcea..a4e336f6 100644 --- a/lib/orb/errors.rb +++ b/lib/orb/errors.rb @@ -1,280 +1,317 @@ # frozen_string_literal: true module Orb - class Error < StandardError - # @!parse - # # @return [StandardError, nil] - # attr_accessor :cause - end + module Errors + class Error < StandardError + # @!parse + # # @return [StandardError, nil] + # attr_accessor :cause + end - class ConversionError < Orb::Error - end + class ConversionError < Orb::Errors::Error + end - class APIError < Orb::Error - # @return [URI::Generic] - attr_accessor :url - - # @return [Integer, nil] - attr_accessor :status - - # @return [Object, nil] - attr_accessor :body - - # @api private - # - # @param url [URI::Generic] - # @param status [Integer, nil] - # @param body [Object, nil] - # @param request [nil] - # @param response [nil] - # @param message [String, nil] - def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil) - @url = url - @status = status - @body = body - @request = request - @response = response - super(message) + class APIError < Orb::Errors::Error + # @return [URI::Generic] + attr_accessor :url + + # @return [Integer, nil] + attr_accessor :status + + # @return [Object, nil] + attr_accessor :body + + # @api private + # + # @param url [URI::Generic] + # @param status [Integer, nil] + # @param body [Object, nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil) + @url = url + @status = status + @body = body + @request = request + @response = response + super(message) + end end - end - class APIConnectionError < Orb::APIError - # @!parse - # # @return [nil] - # attr_accessor :status - - # @!parse - # # @return [nil] - # attr_accessor :body - - # @api private - # - # @param url [URI::Generic] - # @param status [nil] - # @param body [nil] - # @param request [nil] - # @param response [nil] - # @param message [String, nil] - def initialize( - url:, - status: nil, - body: nil, - request: nil, - response: nil, - message: "Connection error." - ) - super + class APIConnectionError < Orb::Errors::APIError + # @!parse + # # @return [nil] + # attr_accessor :status + + # @!parse + # # @return [nil] + # attr_accessor :body + + # @api private + # + # @param url [URI::Generic] + # @param status [nil] + # @param body [nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + def initialize( + url:, + status: nil, + body: nil, + request: nil, + response: nil, + message: "Connection error." + ) + super + end end - end - class APITimeoutError < Orb::APIConnectionError - # @api private - # - # @param url [URI::Generic] - # @param status [nil] - # @param body [nil] - # @param request [nil] - # @param response [nil] - # @param message [String, nil] - def initialize( - url:, - status: nil, - body: nil, - request: nil, - response: nil, - message: "Request timed out." - ) - super + class APITimeoutError < Orb::Errors::APIConnectionError + # @api private + # + # @param url [URI::Generic] + # @param status [nil] + # @param body [nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + def initialize( + url:, + status: nil, + body: nil, + request: nil, + response: nil, + message: "Request timed out." + ) + super + end end - end - class APIStatusError < Orb::APIError - # @api private - # - # @param url [URI::Generic] - # @param status [Integer] - # @param body [Object, nil] - # @param request [nil] - # @param response [nil] - # @param message [String, nil] - # - # @return [Orb::APIStatusError] - def self.for(url:, status:, body:, request:, response:, message: nil) - key = Orb::Util.dig(body, :type) - kwargs = {url: url, status: status, body: body, request: request, response: response, message: message} - - case [status, key] - in [400, Orb::ConstraintViolation::TYPE] - Orb::ConstraintViolation.new(**kwargs) - in [400, Orb::DuplicateResourceCreation::TYPE] - Orb::DuplicateResourceCreation.new(**kwargs) - in [400, Orb::FeatureNotAvailable::TYPE] - Orb::FeatureNotAvailable.new(**kwargs) - in [400, Orb::RequestValidationError::TYPE] - Orb::RequestValidationError.new(**kwargs) - in [401, Orb::OrbAuthenticationError::TYPE] - Orb::OrbAuthenticationError.new(**kwargs) - in [404, Orb::ResourceNotFound::TYPE] - Orb::ResourceNotFound.new(**kwargs) - in [404, Orb::URLNotFound::TYPE] - Orb::URLNotFound.new(**kwargs) - in [409, Orb::ResourceConflict::TYPE] - Orb::ResourceConflict.new(**kwargs) - in [413, Orb::RequestTooLarge::TYPE] - Orb::RequestTooLarge.new(**kwargs) - in [413, Orb::ResourceTooLarge::TYPE] - Orb::ResourceTooLarge.new(**kwargs) - in [429, Orb::TooManyRequests::TYPE] - Orb::TooManyRequests.new(**kwargs) - in [(500..), Orb::OrbInternalServerError::TYPE] - Orb::OrbInternalServerError.new(**kwargs) - in [400, _] - Orb::BadRequestError.new(**kwargs) - in [401, _] - Orb::AuthenticationError.new(**kwargs) - in [403, _] - Orb::PermissionDeniedError.new(**kwargs) - in [404, _] - Orb::NotFoundError.new(**kwargs) - in [409, _] - Orb::ConflictError.new(**kwargs) - in [422, _] - Orb::UnprocessableEntityError.new(**kwargs) - in [429, _] - Orb::RateLimitError.new(**kwargs) - in [(500..), _] - Orb::InternalServerError.new(**kwargs) - else - Orb::APIStatusError.new(**kwargs) + class APIStatusError < Orb::Errors::APIError + # @api private + # + # @param url [URI::Generic] + # @param status [Integer] + # @param body [Object, nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + # + # @return [Orb::Errors::APIStatusError] + def self.for(url:, status:, body:, request:, response:, message: nil) + key = Orb::Util.dig(body, :type) + kwargs = { + url: url, + status: status, + body: body, + request: request, + response: response, + message: message + } + + case [status, key] + in [400, Orb::Errors::ConstraintViolation::TYPE] + Orb::Errors::ConstraintViolation.new(**kwargs) + in [400, Orb::Errors::DuplicateResourceCreation::TYPE] + Orb::Errors::DuplicateResourceCreation.new(**kwargs) + in [400, Orb::Errors::FeatureNotAvailable::TYPE] + Orb::Errors::FeatureNotAvailable.new(**kwargs) + in [400, Orb::Errors::RequestValidationError::TYPE] + Orb::Errors::RequestValidationError.new(**kwargs) + in [401, Orb::Errors::OrbAuthenticationError::TYPE] + Orb::Errors::OrbAuthenticationError.new(**kwargs) + in [404, Orb::Errors::ResourceNotFound::TYPE] + Orb::Errors::ResourceNotFound.new(**kwargs) + in [404, Orb::Errors::URLNotFound::TYPE] + Orb::Errors::URLNotFound.new(**kwargs) + in [409, Orb::Errors::ResourceConflict::TYPE] + Orb::Errors::ResourceConflict.new(**kwargs) + in [413, Orb::Errors::RequestTooLarge::TYPE] + Orb::Errors::RequestTooLarge.new(**kwargs) + in [413, Orb::Errors::ResourceTooLarge::TYPE] + Orb::Errors::ResourceTooLarge.new(**kwargs) + in [429, Orb::Errors::TooManyRequests::TYPE] + Orb::Errors::TooManyRequests.new(**kwargs) + in [(500..), Orb::Errors::OrbInternalServerError::TYPE] + Orb::Errors::OrbInternalServerError.new(**kwargs) + in [400, _] + Orb::Errors::BadRequestError.new(**kwargs) + in [401, _] + Orb::Errors::AuthenticationError.new(**kwargs) + in [403, _] + Orb::Errors::PermissionDeniedError.new(**kwargs) + in [404, _] + Orb::Errors::NotFoundError.new(**kwargs) + in [409, _] + Orb::Errors::ConflictError.new(**kwargs) + in [422, _] + Orb::Errors::UnprocessableEntityError.new(**kwargs) + in [429, _] + Orb::Errors::RateLimitError.new(**kwargs) + in [(500..), _] + Orb::Errors::InternalServerError.new(**kwargs) + else + Orb::Errors::APIStatusError.new(**kwargs) + end + end + + # @!parse + # # @return [Integer] + # attr_accessor :status + + # @api private + # + # @param url [URI::Generic] + # @param status [Integer] + # @param body [Object, nil] + # @param request [nil] + # @param response [nil] + # @param message [String, nil] + def initialize(url:, status:, body:, request:, response:, message: nil) + message ||= {url: url.to_s, status: status, body: body} + super( + url: url, + status: status, + body: body, + request: request, + response: response, + message: message&.to_s + ) end end - # @!parse - # # @return [Integer] - # attr_accessor :status - - # @api private - # - # @param url [URI::Generic] - # @param status [Integer] - # @param body [Object, nil] - # @param request [nil] - # @param response [nil] - # @param message [String, nil] - def initialize(url:, status:, body:, request:, response:, message: nil) - message ||= {url: url.to_s, status: status, body: body} - super( - url: url, - status: status, - body: body, - request: request, - response: response, - message: message&.to_s - ) + class BadRequestError < Orb::Errors::APIStatusError + HTTP_STATUS = 400 end - end - class BadRequestError < Orb::APIStatusError - HTTP_STATUS = 400 - end + class AuthenticationError < Orb::Errors::APIStatusError + HTTP_STATUS = 401 + end - class AuthenticationError < Orb::APIStatusError - HTTP_STATUS = 401 - end + class PermissionDeniedError < Orb::Errors::APIStatusError + HTTP_STATUS = 403 + end - class PermissionDeniedError < Orb::APIStatusError - HTTP_STATUS = 403 - end + class NotFoundError < Orb::Errors::APIStatusError + HTTP_STATUS = 404 + end - class NotFoundError < Orb::APIStatusError - HTTP_STATUS = 404 - end + class ConflictError < Orb::Errors::APIStatusError + HTTP_STATUS = 409 + end - class ConflictError < Orb::APIStatusError - HTTP_STATUS = 409 - end + class UnprocessableEntityError < Orb::Errors::APIStatusError + HTTP_STATUS = 422 + end - class UnprocessableEntityError < Orb::APIStatusError - HTTP_STATUS = 422 - end + class RateLimitError < Orb::Errors::APIStatusError + HTTP_STATUS = 429 + end - class RateLimitError < Orb::APIStatusError - HTTP_STATUS = 429 - end + class InternalServerError < Orb::Errors::APIStatusError + HTTP_STATUS = (500..) + end - class InternalServerError < Orb::APIStatusError - HTTP_STATUS = (500..) - end + class ConstraintViolation < Orb::Errors::BadRequestError + TYPE = "https://docs.withorb.com/reference/error-responses#400-constraint-violation" + end - class ConstraintViolation < Orb::BadRequestError - HTTP_STATUS = Orb::BadRequestError::HTTP_STATUS + class DuplicateResourceCreation < Orb::Errors::BadRequestError + TYPE = "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation" + end - TYPE = "https://docs.withorb.com/reference/error-responses#400-constraint-violation" - end + class FeatureNotAvailable < Orb::Errors::BadRequestError + TYPE = "https://docs.withorb.com/reference/error-responses#404-feature-not-available" + end - class DuplicateResourceCreation < Orb::BadRequestError - HTTP_STATUS = Orb::BadRequestError::HTTP_STATUS + class RequestValidationError < Orb::Errors::BadRequestError + TYPE = "https://docs.withorb.com/reference/error-responses#400-request-validation-errors" + end - TYPE = "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation" - end + class OrbAuthenticationError < Orb::Errors::AuthenticationError + TYPE = "https://docs.withorb.com/reference/error-responses#401-authentication-error" + end - class FeatureNotAvailable < Orb::BadRequestError - HTTP_STATUS = Orb::BadRequestError::HTTP_STATUS + class ResourceNotFound < Orb::Errors::NotFoundError + TYPE = "https://docs.withorb.com/reference/error-responses#404-resource-not-found" + end - TYPE = "https://docs.withorb.com/reference/error-responses#404-feature-not-available" - end + class URLNotFound < Orb::Errors::NotFoundError + TYPE = "https://docs.withorb.com/reference/error-responses#404-url-not-found" + end - class RequestValidationError < Orb::BadRequestError - HTTP_STATUS = Orb::BadRequestError::HTTP_STATUS + class ResourceConflict < Orb::Errors::ConflictError + TYPE = "https://docs.withorb.com/reference/error-responses#409-resource-conflict" + end - TYPE = "https://docs.withorb.com/reference/error-responses#400-request-validation-errors" - end + class RequestTooLarge < Orb::Errors::APIStatusError + TYPE = "https://docs.withorb.com/reference/error-responses#413-request-too-large" + end + + class ResourceTooLarge < Orb::Errors::APIStatusError + TYPE = "https://docs.withorb.com/reference/error-responses#413-resource-too-large" + end - class OrbAuthenticationError < Orb::AuthenticationError - HTTP_STATUS = Orb::AuthenticationError::HTTP_STATUS + class TooManyRequests < Orb::Errors::RateLimitError + TYPE = "https://docs.withorb.com/reference/error-responses#429-too-many-requests" + end - TYPE = "https://docs.withorb.com/reference/error-responses#401-authentication-error" + class OrbInternalServerError < Orb::Errors::InternalServerError + TYPE = "https://docs.withorb.com/reference/error-responses#500-internal-server-error" + end end - class ResourceNotFound < Orb::NotFoundError - HTTP_STATUS = Orb::NotFoundError::HTTP_STATUS + Error = Orb::Errors::Error - TYPE = "https://docs.withorb.com/reference/error-responses#404-resource-not-found" - end + ConversionError = Orb::Errors::ConversionError - class URLNotFound < Orb::NotFoundError - HTTP_STATUS = Orb::NotFoundError::HTTP_STATUS + APIError = Orb::Errors::APIError - TYPE = "https://docs.withorb.com/reference/error-responses#404-url-not-found" - end + APIStatusError = Orb::Errors::APIStatusError - class ResourceConflict < Orb::ConflictError - HTTP_STATUS = Orb::ConflictError::HTTP_STATUS + APIConnectionError = Orb::Errors::APIConnectionError - TYPE = "https://docs.withorb.com/reference/error-responses#409-resource-conflict" - end + APITimeoutError = Orb::Errors::APITimeoutError - class RequestTooLarge < Orb::APIStatusError - HTTP_STATUS = 413 + BadRequestError = Orb::Errors::BadRequestError - TYPE = "https://docs.withorb.com/reference/error-responses#413-request-too-large" - end + AuthenticationError = Orb::Errors::AuthenticationError - class ResourceTooLarge < Orb::APIStatusError - HTTP_STATUS = 413 + PermissionDeniedError = Orb::Errors::PermissionDeniedError - TYPE = "https://docs.withorb.com/reference/error-responses#413-resource-too-large" - end + NotFoundError = Orb::Errors::NotFoundError - class TooManyRequests < Orb::RateLimitError - HTTP_STATUS = Orb::RateLimitError::HTTP_STATUS + ConflictError = Orb::Errors::ConflictError - TYPE = "https://docs.withorb.com/reference/error-responses#429-too-many-requests" - end + UnprocessableEntityError = Orb::Errors::UnprocessableEntityError - class OrbInternalServerError < Orb::InternalServerError - HTTP_STATUS = Orb::InternalServerError::HTTP_STATUS + RateLimitError = Orb::Errors::RateLimitError - TYPE = "https://docs.withorb.com/reference/error-responses#500-internal-server-error" - end + InternalServerError = Orb::Errors::InternalServerError + + ConstraintViolation = Orb::Errors::ConstraintViolation + + DuplicateResourceCreation = Orb::Errors::DuplicateResourceCreation + + FeatureNotAvailable = Orb::Errors::FeatureNotAvailable + + RequestValidationError = Orb::Errors::RequestValidationError + + OrbAuthenticationError = Orb::Errors::OrbAuthenticationError + + ResourceNotFound = Orb::Errors::ResourceNotFound + + URLNotFound = Orb::Errors::URLNotFound + + ResourceConflict = Orb::Errors::ResourceConflict + + RequestTooLarge = Orb::Errors::RequestTooLarge + + ResourceTooLarge = Orb::Errors::ResourceTooLarge + + TooManyRequests = Orb::Errors::TooManyRequests + + OrbInternalServerError = Orb::Errors::OrbInternalServerError end diff --git a/lib/orb/transport/base_client.rb b/lib/orb/transport/base_client.rb index d2bce249..6e1bdad0 100644 --- a/lib/orb/transport/base_client.rb +++ b/lib/orb/transport/base_client.rb @@ -92,7 +92,7 @@ def follow_redirect(request, status:, response_headers:) URI.join(url, response_headers["location"]) rescue ArgumentError message = "Server responded with status #{status} but no valid location header." - raise Orb::APIConnectionError.new(url: url, message: message) + raise Orb::Errors::APIConnectionError.new(url: url, message: message) end request = {**request, url: location} @@ -100,7 +100,7 @@ def follow_redirect(request, status:, response_headers:) case [url.scheme, location.scheme] in ["https", "http"] message = "Tried to redirect to a insecure URL" - raise Orb::APIConnectionError.new(url: url, message: message) + raise Orb::Errors::APIConnectionError.new(url: url, message: message) else nil end @@ -129,13 +129,13 @@ def follow_redirect(request, status:, response_headers:) # @api private # - # @param status [Integer, Orb::APIConnectionError] + # @param status [Integer, Orb::Errors::APIConnectionError] # @param stream [Enumerable, nil] def reap_connection!(status, stream:) case status in (..199) | (300..499) stream&.each { next } - in Orb::APIConnectionError | (500..) + in Orb::Errors::APIConnectionError | (500..) Orb::Util.close_fused!(stream) else end @@ -326,7 +326,7 @@ def initialize( # # @param send_retry_header [Boolean] # - # @raise [Orb::APIError] + # @raise [Orb::Errors::APIError] # @return [Array(Integer, Net::HTTPResponse, Enumerable)] private def send_request(request, redirect_count:, retry_count:, send_retry_header:) url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout) @@ -349,7 +349,7 @@ def initialize( self.class.reap_connection!(status, stream: stream) message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects." - raise Orb::APIConnectionError.new(url: url, message: message) + raise Orb::Errors::APIConnectionError.new(url: url, message: message) in 300..399 self.class.reap_connection!(status, stream: stream) @@ -369,14 +369,14 @@ def initialize( self.class.reap_connection!(status, stream: stream) end - raise Orb::APIStatusError.for( + raise Orb::Errors::APIStatusError.for( url: url, status: status, body: decoded, request: nil, response: response ) - in (400..) | Orb::APIConnectionError + in (400..) | Orb::Errors::APIConnectionError self.class.reap_connection!(status, stream: stream) delay = retry_delay(response, retry_count: retry_count) @@ -416,7 +416,7 @@ def initialize( # # @option req [Orb::RequestOptions, Hash{Symbol=>Object}, nil] :options # - # @raise [Orb::APIError] + # @raise [Orb::Errors::APIError] # @return [Object] def request(req) self.class.validate!(req) diff --git a/lib/orb/transport/pooled_net_requester.rb b/lib/orb/transport/pooled_net_requester.rb index d3c7449d..fd0c167e 100644 --- a/lib/orb/transport/pooled_net_requester.rb +++ b/lib/orb/transport/pooled_net_requester.rb @@ -153,7 +153,7 @@ def execute(request) end end rescue Timeout::Error - raise Orb::APITimeoutError + raise Orb::Errors::APITimeoutError end conn, _, response = enum.next diff --git a/lib/orb/type/base_model.rb b/lib/orb/type/base_model.rb index 27ad09ba..1359d785 100644 --- a/lib/orb/type/base_model.rb +++ b/lib/orb/type/base_model.rb @@ -331,6 +331,16 @@ def deconstruct_keys(keys) .to_h end + # @param a [Object] + # + # @return [String] + def to_json(*a) = self.class.dump(self).to_json(*a) + + # @param a [Object] + # + # @return [String] + def to_yaml(*a) = self.class.dump(self).to_yaml(*a) + # Create a new instance of a model. # # @param data [Hash{Symbol=>Object}, Orb::BaseModel] diff --git a/lib/orb/type/base_page.rb b/lib/orb/type/base_page.rb index 671ee07c..c01fd104 100644 --- a/lib/orb/type/base_page.rb +++ b/lib/orb/type/base_page.rb @@ -29,7 +29,7 @@ module BasePage # @return [Boolean] def next_page? = (raise NotImplementedError) - # @raise [Orb::APIError] + # @raise [Orb::Errors::APIError] # @return [Orb::Type::BasePage] def next_page = (raise NotImplementedError) diff --git a/lib/orb/util.rb b/lib/orb/util.rb index 66236f72..b29eb690 100644 --- a/lib/orb/util.rb +++ b/lib/orb/util.rb @@ -441,7 +441,7 @@ class << self # # @yieldparam [Enumerator::Yielder] # @return [Enumerable] - def string_io(&blk) + def writable_enum(&blk) Enumerator.new do |y| y.define_singleton_method(:write) do self << _1.clone @@ -454,15 +454,13 @@ def string_io(&blk) end class << self - # rubocop:disable Naming/MethodParameterName - # @api private # # @param y [Enumerator::Yielder] # @param boundary [String] # @param key [Symbol, String] # @param val [Object] - private def encode_multipart_formdata(y, boundary:, key:, val:) + private def write_multipart_chunk(y, boundary:, key:, val:) y << "--#{boundary}\r\n" y << "Content-Disposition: form-data" unless key.nil? @@ -494,8 +492,6 @@ class << self y << "\r\n" end - # rubocop:enable Naming/MethodParameterName - # @api private # # @param body [Object] @@ -504,21 +500,21 @@ class << self private def encode_multipart_streaming(body) boundary = SecureRandom.urlsafe_base64(60) - strio = string_io do |y| + strio = writable_enum do |y| case body in Hash body.each do |key, val| case val in Array if val.all? { primitive?(_1) } val.each do |v| - encode_multipart_formdata(y, boundary: boundary, key: key, val: v) + write_multipart_chunk(y, boundary: boundary, key: key, val: v) end else - encode_multipart_formdata(y, boundary: boundary, key: key, val: val) + write_multipart_chunk(y, boundary: boundary, key: key, val: val) end end else - encode_multipart_formdata(y, boundary: boundary, key: nil, val: body) + write_multipart_chunk(y, boundary: boundary, key: nil, val: body) end y << "--#{boundary}--\r\n" end diff --git a/rbi/lib/orb/errors.rbi b/rbi/lib/orb/errors.rbi index 861c86d0..bbac38a3 100644 --- a/rbi/lib/orb/errors.rbi +++ b/rbi/lib/orb/errors.rbi @@ -1,216 +1,246 @@ # typed: strong module Orb - class Error < StandardError - sig { returns(T.nilable(StandardError)) } - attr_accessor :cause - end + module Errors + class Error < StandardError + sig { returns(T.nilable(StandardError)) } + attr_accessor :cause + end - class ConversionError < Orb::Error - end + class ConversionError < Orb::Errors::Error + end - class APIError < Orb::Error - sig { returns(URI::Generic) } - attr_accessor :url + class APIError < Orb::Errors::Error + sig { returns(URI::Generic) } + attr_accessor :url + + sig { returns(T.nilable(Integer)) } + attr_accessor :status + + sig { returns(T.nilable(T.anything)) } + attr_accessor :body + + # @api private + sig do + params( + url: URI::Generic, + status: T.nilable(Integer), + body: T.nilable(Object), + request: NilClass, + response: NilClass, + message: T.nilable(String) + ) + .returns(T.attached_class) + end + def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil) + end + end - sig { returns(T.nilable(Integer)) } - attr_accessor :status + class APIConnectionError < Orb::Errors::APIError + sig { void } + attr_accessor :status + + sig { void } + attr_accessor :body + + # @api private + sig do + params( + url: URI::Generic, + status: NilClass, + body: NilClass, + request: NilClass, + response: NilClass, + message: T.nilable(String) + ) + .returns(T.attached_class) + end + def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.") + end + end - sig { returns(T.nilable(T.anything)) } - attr_accessor :body + class APITimeoutError < Orb::Errors::APIConnectionError + # @api private + sig do + params( + url: URI::Generic, + status: NilClass, + body: NilClass, + request: NilClass, + response: NilClass, + message: T.nilable(String) + ) + .returns(T.attached_class) + end + def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.") + end + end - # @api private - sig do - params( - url: URI::Generic, - status: T.nilable(Integer), - body: T.nilable(Object), - request: NilClass, - response: NilClass, - message: T.nilable(String) - ) - .returns(T.attached_class) + class APIStatusError < Orb::Errors::APIError + # @api private + sig do + params( + url: URI::Generic, + status: Integer, + body: T.nilable(Object), + request: NilClass, + response: NilClass, + message: T.nilable(String) + ) + .returns(T.attached_class) + end + def self.for(url:, status:, body:, request:, response:, message: nil) + end + + sig { returns(Integer) } + attr_accessor :status + + # @api private + sig do + params( + url: URI::Generic, + status: Integer, + body: T.nilable(Object), + request: NilClass, + response: NilClass, + message: T.nilable(String) + ) + .returns(T.attached_class) + end + def self.new(url:, status:, body:, request:, response:, message: nil) + end end - def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil) + + class BadRequestError < Orb::Errors::APIStatusError + HTTP_STATUS = 400 end - end - class APIConnectionError < Orb::APIError - sig { void } - attr_accessor :status + class AuthenticationError < Orb::Errors::APIStatusError + HTTP_STATUS = 401 + end - sig { void } - attr_accessor :body + class PermissionDeniedError < Orb::Errors::APIStatusError + HTTP_STATUS = 403 + end - # @api private - sig do - params( - url: URI::Generic, - status: NilClass, - body: NilClass, - request: NilClass, - response: NilClass, - message: T.nilable(String) - ) - .returns(T.attached_class) + class NotFoundError < Orb::Errors::APIStatusError + HTTP_STATUS = 404 end - def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.") + + class ConflictError < Orb::Errors::APIStatusError + HTTP_STATUS = 409 end - end - class APITimeoutError < Orb::APIConnectionError - # @api private - sig do - params( - url: URI::Generic, - status: NilClass, - body: NilClass, - request: NilClass, - response: NilClass, - message: T.nilable(String) - ) - .returns(T.attached_class) - end - def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.") + class UnprocessableEntityError < Orb::Errors::APIStatusError + HTTP_STATUS = 422 end - end - class APIStatusError < Orb::APIError - # @api private - sig do - params( - url: URI::Generic, - status: Integer, - body: T.nilable(Object), - request: NilClass, - response: NilClass, - message: T.nilable(String) - ) - .returns(T.attached_class) - end - def self.for(url:, status:, body:, request:, response:, message: nil) - end - - sig { returns(Integer) } - attr_accessor :status - - # @api private - sig do - params( - url: URI::Generic, - status: Integer, - body: T.nilable(Object), - request: NilClass, - response: NilClass, - message: T.nilable(String) - ) - .returns(T.attached_class) - end - def self.new(url:, status:, body:, request:, response:, message: nil) + class RateLimitError < Orb::Errors::APIStatusError + HTTP_STATUS = 429 end - end - class BadRequestError < Orb::APIStatusError - HTTP_STATUS = 400 - end + class InternalServerError < Orb::Errors::APIStatusError + HTTP_STATUS = T.let((500..), T::Range[Integer]) + end - class AuthenticationError < Orb::APIStatusError - HTTP_STATUS = 401 - end + class ConstraintViolation < Orb::Errors::BadRequestError + TYPE = "https://docs.withorb.com/reference/error-responses#400-constraint-violation" + end - class PermissionDeniedError < Orb::APIStatusError - HTTP_STATUS = 403 - end + class DuplicateResourceCreation < Orb::Errors::BadRequestError + TYPE = "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation" + end - class NotFoundError < Orb::APIStatusError - HTTP_STATUS = 404 - end + class FeatureNotAvailable < Orb::Errors::BadRequestError + TYPE = "https://docs.withorb.com/reference/error-responses#404-feature-not-available" + end - class ConflictError < Orb::APIStatusError - HTTP_STATUS = 409 - end + class RequestValidationError < Orb::Errors::BadRequestError + TYPE = "https://docs.withorb.com/reference/error-responses#400-request-validation-errors" + end - class UnprocessableEntityError < Orb::APIStatusError - HTTP_STATUS = 422 - end + class OrbAuthenticationError < Orb::Errors::AuthenticationError + TYPE = "https://docs.withorb.com/reference/error-responses#401-authentication-error" + end - class RateLimitError < Orb::APIStatusError - HTTP_STATUS = 429 - end + class ResourceNotFound < Orb::Errors::NotFoundError + TYPE = "https://docs.withorb.com/reference/error-responses#404-resource-not-found" + end - class InternalServerError < Orb::APIStatusError - HTTP_STATUS = T.let((500..), T::Range[Integer]) - end + class URLNotFound < Orb::Errors::NotFoundError + TYPE = "https://docs.withorb.com/reference/error-responses#404-url-not-found" + end - class ConstraintViolation < Orb::BadRequestError - HTTP_STATUS = 400 + class ResourceConflict < Orb::Errors::ConflictError + TYPE = "https://docs.withorb.com/reference/error-responses#409-resource-conflict" + end - TYPE = "https://docs.withorb.com/reference/error-responses#400-constraint-violation" - end + class RequestTooLarge < Orb::Errors::APIStatusError + TYPE = "https://docs.withorb.com/reference/error-responses#413-request-too-large" + end - class DuplicateResourceCreation < Orb::BadRequestError - HTTP_STATUS = 400 + class ResourceTooLarge < Orb::Errors::APIStatusError + TYPE = "https://docs.withorb.com/reference/error-responses#413-resource-too-large" + end + + class TooManyRequests < Orb::Errors::RateLimitError + TYPE = "https://docs.withorb.com/reference/error-responses#429-too-many-requests" + end - TYPE = "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation" + class OrbInternalServerError < Orb::Errors::InternalServerError + TYPE = "https://docs.withorb.com/reference/error-responses#500-internal-server-error" + end end - class FeatureNotAvailable < Orb::BadRequestError - HTTP_STATUS = 400 + Error = Orb::Errors::Error - TYPE = "https://docs.withorb.com/reference/error-responses#404-feature-not-available" - end + ConversionError = Orb::Errors::ConversionError - class RequestValidationError < Orb::BadRequestError - HTTP_STATUS = 400 + APIError = Orb::Errors::APIError - TYPE = "https://docs.withorb.com/reference/error-responses#400-request-validation-errors" - end + APIStatusError = Orb::Errors::APIStatusError - class OrbAuthenticationError < Orb::AuthenticationError - HTTP_STATUS = 401 + APIConnectionError = Orb::Errors::APIConnectionError - TYPE = "https://docs.withorb.com/reference/error-responses#401-authentication-error" - end + APITimeoutError = Orb::Errors::APITimeoutError - class ResourceNotFound < Orb::NotFoundError - HTTP_STATUS = 404 + BadRequestError = Orb::Errors::BadRequestError - TYPE = "https://docs.withorb.com/reference/error-responses#404-resource-not-found" - end + AuthenticationError = Orb::Errors::AuthenticationError - class URLNotFound < Orb::NotFoundError - HTTP_STATUS = 404 + PermissionDeniedError = Orb::Errors::PermissionDeniedError - TYPE = "https://docs.withorb.com/reference/error-responses#404-url-not-found" - end + NotFoundError = Orb::Errors::NotFoundError - class ResourceConflict < Orb::ConflictError - HTTP_STATUS = 409 + ConflictError = Orb::Errors::ConflictError - TYPE = "https://docs.withorb.com/reference/error-responses#409-resource-conflict" - end + UnprocessableEntityError = Orb::Errors::UnprocessableEntityError - class RequestTooLarge < Orb::APIStatusError - HTTP_STATUS = 413 + RateLimitError = Orb::Errors::RateLimitError - TYPE = "https://docs.withorb.com/reference/error-responses#413-request-too-large" - end + InternalServerError = Orb::Errors::InternalServerError - class ResourceTooLarge < Orb::APIStatusError - HTTP_STATUS = 413 + ConstraintViolation = Orb::Errors::ConstraintViolation - TYPE = "https://docs.withorb.com/reference/error-responses#413-resource-too-large" - end + DuplicateResourceCreation = Orb::Errors::DuplicateResourceCreation - class TooManyRequests < Orb::RateLimitError - HTTP_STATUS = 429 + FeatureNotAvailable = Orb::Errors::FeatureNotAvailable - TYPE = "https://docs.withorb.com/reference/error-responses#429-too-many-requests" - end + RequestValidationError = Orb::Errors::RequestValidationError - class OrbInternalServerError < Orb::InternalServerError - HTTP_STATUS = T.let((500..), T::Range[Integer]) + OrbAuthenticationError = Orb::Errors::OrbAuthenticationError - TYPE = "https://docs.withorb.com/reference/error-responses#500-internal-server-error" - end + ResourceNotFound = Orb::Errors::ResourceNotFound + + URLNotFound = Orb::Errors::URLNotFound + + ResourceConflict = Orb::Errors::ResourceConflict + + RequestTooLarge = Orb::Errors::RequestTooLarge + + ResourceTooLarge = Orb::Errors::ResourceTooLarge + + TooManyRequests = Orb::Errors::TooManyRequests + + OrbInternalServerError = Orb::Errors::OrbInternalServerError end diff --git a/rbi/lib/orb/transport/base_client.rbi b/rbi/lib/orb/transport/base_client.rbi index 8b87db16..c48df08b 100644 --- a/rbi/lib/orb/transport/base_client.rbi +++ b/rbi/lib/orb/transport/base_client.rbi @@ -82,9 +82,10 @@ module Orb # @api private sig do params( - status: T.any(Integer, Orb::APIConnectionError), + status: T.any(Integer, Orb::Errors::APIConnectionError), stream: T.nilable(T::Enumerable[String]) - ).void + ) + .void end def reap_connection!(status, stream:) end diff --git a/rbi/lib/orb/type/base_model.rbi b/rbi/lib/orb/type/base_model.rbi index 4c67f7df..c6d27f88 100644 --- a/rbi/lib/orb/type/base_model.rbi +++ b/rbi/lib/orb/type/base_model.rbi @@ -176,6 +176,14 @@ module Orb def deconstruct_keys(keys) end + sig { params(a: T.anything).returns(String) } + def to_json(*a) + end + + sig { params(a: T.anything).returns(String) } + def to_yaml(*a) + end + # 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 = {}) diff --git a/rbi/lib/orb/util.rbi b/rbi/lib/orb/util.rbi index 690f8209..d00f20fe 100644 --- a/rbi/lib/orb/util.rbi +++ b/rbi/lib/orb/util.rbi @@ -196,7 +196,7 @@ module Orb class << self sig { params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(T::Enumerable[String]) } - def string_io(&blk) + def writable_enum(&blk) end end @@ -205,7 +205,7 @@ module Orb sig do params(y: Enumerator::Yielder, boundary: String, key: T.any(Symbol, String), val: T.anything).void end - private def encode_multipart_formdata(y, boundary:, key:, val:) + private def write_multipart_chunk(y, boundary:, key:, val:) end # @api private diff --git a/sig/orb/errors.rbs b/sig/orb/errors.rbs index b12bd045..b75a8a67 100644 --- a/sig/orb/errors.rbs +++ b/sig/orb/errors.rbs @@ -1,171 +1,201 @@ module Orb - class Error < StandardError - attr_accessor cause: StandardError? - end + module Errors + class Error < StandardError + attr_accessor cause: StandardError? + end + + class ConversionError < Orb::Errors::Error + end + + class APIError < Orb::Errors::Error + attr_accessor url: URI::Generic + + attr_accessor status: Integer? + + attr_accessor body: top? + + def initialize: ( + url: URI::Generic, + ?status: Integer?, + ?body: Object?, + ?request: nil, + ?response: nil, + ?message: String? + ) -> void + end + + class APIConnectionError < Orb::Errors::APIError + def initialize: ( + url: URI::Generic, + ?status: nil, + ?body: nil, + ?request: nil, + ?response: nil, + ?message: String? + ) -> void + end + + class APITimeoutError < Orb::Errors::APIConnectionError + def initialize: ( + url: URI::Generic, + ?status: nil, + ?body: nil, + ?request: nil, + ?response: nil, + ?message: String? + ) -> void + end + + class APIStatusError < Orb::Errors::APIError + def self.for: ( + url: URI::Generic, + status: Integer, + body: Object?, + request: nil, + response: nil, + ?message: String? + ) -> instance + + def initialize: ( + url: URI::Generic, + status: Integer, + body: Object?, + request: nil, + response: nil, + ?message: String? + ) -> void + end + + class BadRequestError < Orb::Errors::APIStatusError + HTTP_STATUS: 400 + end - class ConversionError < Orb::Error - end + class AuthenticationError < Orb::Errors::APIStatusError + HTTP_STATUS: 401 + end - class APIError < Orb::Error - attr_accessor url: URI::Generic + class PermissionDeniedError < Orb::Errors::APIStatusError + HTTP_STATUS: 403 + end - attr_accessor status: Integer? + class NotFoundError < Orb::Errors::APIStatusError + HTTP_STATUS: 404 + end - attr_accessor body: top? + class ConflictError < Orb::Errors::APIStatusError + HTTP_STATUS: 409 + end - def initialize: ( - url: URI::Generic, - ?status: Integer?, - ?body: Object?, - ?request: nil, - ?response: nil, - ?message: String? - ) -> void - end + class UnprocessableEntityError < Orb::Errors::APIStatusError + HTTP_STATUS: 422 + end - class APIConnectionError < Orb::APIError - def initialize: ( - url: URI::Generic, - ?status: nil, - ?body: nil, - ?request: nil, - ?response: nil, - ?message: String? - ) -> void - end + class RateLimitError < Orb::Errors::APIStatusError + HTTP_STATUS: 429 + end - class APITimeoutError < Orb::APIConnectionError - def initialize: ( - url: URI::Generic, - ?status: nil, - ?body: nil, - ?request: nil, - ?response: nil, - ?message: String? - ) -> void - end + class InternalServerError < Orb::Errors::APIStatusError + HTTP_STATUS: Range[Integer] + end - class APIStatusError < Orb::APIError - def self.for: ( - url: URI::Generic, - status: Integer, - body: Object?, - request: nil, - response: nil, - ?message: String? - ) -> instance - - def initialize: ( - url: URI::Generic, - status: Integer, - body: Object?, - request: nil, - response: nil, - ?message: String? - ) -> void - end + class ConstraintViolation < Orb::Errors::BadRequestError + TYPE: "https://docs.withorb.com/reference/error-responses#400-constraint-violation" + end - class BadRequestError < Orb::APIStatusError - HTTP_STATUS: 400 - end + class DuplicateResourceCreation < Orb::Errors::BadRequestError + TYPE: "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation" + end - class AuthenticationError < Orb::APIStatusError - HTTP_STATUS: 401 - end + class FeatureNotAvailable < Orb::Errors::BadRequestError + TYPE: "https://docs.withorb.com/reference/error-responses#404-feature-not-available" + end - class PermissionDeniedError < Orb::APIStatusError - HTTP_STATUS: 403 - end + class RequestValidationError < Orb::Errors::BadRequestError + TYPE: "https://docs.withorb.com/reference/error-responses#400-request-validation-errors" + end - class NotFoundError < Orb::APIStatusError - HTTP_STATUS: 404 - end + class OrbAuthenticationError < Orb::Errors::AuthenticationError + TYPE: "https://docs.withorb.com/reference/error-responses#401-authentication-error" + end - class ConflictError < Orb::APIStatusError - HTTP_STATUS: 409 - end + class ResourceNotFound < Orb::Errors::NotFoundError + TYPE: "https://docs.withorb.com/reference/error-responses#404-resource-not-found" + end - class UnprocessableEntityError < Orb::APIStatusError - HTTP_STATUS: 422 - end + class URLNotFound < Orb::Errors::NotFoundError + TYPE: "https://docs.withorb.com/reference/error-responses#404-url-not-found" + end - class RateLimitError < Orb::APIStatusError - HTTP_STATUS: 429 - end + class ResourceConflict < Orb::Errors::ConflictError + TYPE: "https://docs.withorb.com/reference/error-responses#409-resource-conflict" + end - class InternalServerError < Orb::APIStatusError - HTTP_STATUS: Range[Integer] - end + class RequestTooLarge < Orb::Errors::APIStatusError + TYPE: "https://docs.withorb.com/reference/error-responses#413-request-too-large" + end + + class ResourceTooLarge < Orb::Errors::APIStatusError + TYPE: "https://docs.withorb.com/reference/error-responses#413-resource-too-large" + end - class ConstraintViolation < Orb::BadRequestError - HTTP_STATUS: 400 + class TooManyRequests < Orb::Errors::RateLimitError + TYPE: "https://docs.withorb.com/reference/error-responses#429-too-many-requests" + end - TYPE: "https://docs.withorb.com/reference/error-responses#400-constraint-violation" + class OrbInternalServerError < Orb::Errors::InternalServerError + TYPE: "https://docs.withorb.com/reference/error-responses#500-internal-server-error" + end end - class DuplicateResourceCreation < Orb::BadRequestError - HTTP_STATUS: 400 + class Error = Orb::Errors::Error - TYPE: "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation" - end + class ConversionError = Orb::Errors::ConversionError - class FeatureNotAvailable < Orb::BadRequestError - HTTP_STATUS: 400 + class APIError = Orb::Errors::APIError - TYPE: "https://docs.withorb.com/reference/error-responses#404-feature-not-available" - end + class APIStatusError = Orb::Errors::APIStatusError - class RequestValidationError < Orb::BadRequestError - HTTP_STATUS: 400 + class APIConnectionError = Orb::Errors::APIConnectionError - TYPE: "https://docs.withorb.com/reference/error-responses#400-request-validation-errors" - end + class APITimeoutError = Orb::Errors::APITimeoutError - class OrbAuthenticationError < Orb::AuthenticationError - HTTP_STATUS: 401 + class BadRequestError = Orb::Errors::BadRequestError - TYPE: "https://docs.withorb.com/reference/error-responses#401-authentication-error" - end + class AuthenticationError = Orb::Errors::AuthenticationError - class ResourceNotFound < Orb::NotFoundError - HTTP_STATUS: 404 + class PermissionDeniedError = Orb::Errors::PermissionDeniedError - TYPE: "https://docs.withorb.com/reference/error-responses#404-resource-not-found" - end + class NotFoundError = Orb::Errors::NotFoundError - class URLNotFound < Orb::NotFoundError - HTTP_STATUS: 404 + class ConflictError = Orb::Errors::ConflictError - TYPE: "https://docs.withorb.com/reference/error-responses#404-url-not-found" - end + class UnprocessableEntityError = Orb::Errors::UnprocessableEntityError - class ResourceConflict < Orb::ConflictError - HTTP_STATUS: 409 + class RateLimitError = Orb::Errors::RateLimitError - TYPE: "https://docs.withorb.com/reference/error-responses#409-resource-conflict" - end + class InternalServerError = Orb::Errors::InternalServerError - class RequestTooLarge < Orb::APIStatusError - HTTP_STATUS: 413 + class ConstraintViolation = Orb::Errors::ConstraintViolation - TYPE: "https://docs.withorb.com/reference/error-responses#413-request-too-large" - end + class DuplicateResourceCreation = Orb::Errors::DuplicateResourceCreation - class ResourceTooLarge < Orb::APIStatusError - HTTP_STATUS: 413 + class FeatureNotAvailable = Orb::Errors::FeatureNotAvailable - TYPE: "https://docs.withorb.com/reference/error-responses#413-resource-too-large" - end + class RequestValidationError = Orb::Errors::RequestValidationError - class TooManyRequests < Orb::RateLimitError - HTTP_STATUS: 429 + class OrbAuthenticationError = Orb::Errors::OrbAuthenticationError - TYPE: "https://docs.withorb.com/reference/error-responses#429-too-many-requests" - end + class ResourceNotFound = Orb::Errors::ResourceNotFound - class OrbInternalServerError < Orb::InternalServerError - HTTP_STATUS: Range[Integer] + class URLNotFound = Orb::Errors::URLNotFound - TYPE: "https://docs.withorb.com/reference/error-responses#500-internal-server-error" - end + class ResourceConflict = Orb::Errors::ResourceConflict + + class RequestTooLarge = Orb::Errors::RequestTooLarge + + class ResourceTooLarge = Orb::Errors::ResourceTooLarge + + class TooManyRequests = Orb::Errors::TooManyRequests + + class OrbInternalServerError = Orb::Errors::OrbInternalServerError end diff --git a/sig/orb/transport/base_client.rbs b/sig/orb/transport/base_client.rbs index 3b2fa0d1..8e833589 100644 --- a/sig/orb/transport/base_client.rbs +++ b/sig/orb/transport/base_client.rbs @@ -47,7 +47,7 @@ module Orb ) -> Orb::Transport::BaseClient::request_input def self.reap_connection!: ( - Integer | Orb::APIConnectionError status, + Integer | Orb::Errors::APIConnectionError status, stream: Enumerable[String]? ) -> void diff --git a/sig/orb/type/base_model.rbs b/sig/orb/type/base_model.rbs index b2166677..3b79d2c2 100644 --- a/sig/orb/type/base_model.rbs +++ b/sig/orb/type/base_model.rbs @@ -65,6 +65,10 @@ module Orb def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top] + def to_json: (*top a) -> String + + def to_yaml: (*top a) -> String + def initialize: (?::Hash[Symbol, top] | self data) -> void def inspect: -> String diff --git a/sig/orb/util.rbs b/sig/orb/util.rbs index 0050a9a6..eabf8a74 100644 --- a/sig/orb/util.rbs +++ b/sig/orb/util.rbs @@ -82,11 +82,11 @@ module Orb } -> void end - def self?.string_io: { + def self?.writable_enum: { (Enumerator::Yielder y) -> void } -> Enumerable[String] - def self?.encode_multipart_formdata: ( + def self?.write_multipart_chunk: ( Enumerator::Yielder y, boundary: String, key: Symbol | String, diff --git a/test/orb/base_model_test.rb b/test/orb/base_model_test.rb index 3df949ba..bceb5cc9 100644 --- a/test/orb/base_model_test.rb +++ b/test/orb/base_model_test.rb @@ -390,7 +390,7 @@ def test_accessors tap do target.public_send(accessor) flunk - rescue Orb::ConversionError => e + rescue Orb::Errors::ConversionError => e assert_kind_of(expect, e.cause) end else diff --git a/test/orb/client_test.rb b/test/orb/client_test.rb index 738541e7..e5051e13 100644 --- a/test/orb/client_test.rb +++ b/test/orb/client_test.rb @@ -191,7 +191,7 @@ def test_client_redirect_307 requester = MockRequester.new(307, {"location" => "/redirected"}, {}) orb.requester = requester - assert_raises(Orb::APIConnectionError) do + assert_raises(Orb::Errors::APIConnectionError) do orb.customers.create(email: "dev@stainless.com", name: "x", request_options: {extra_headers: {}}) end @@ -209,7 +209,7 @@ def test_client_redirect_303 requester = MockRequester.new(303, {"location" => "/redirected"}, {}) orb.requester = requester - assert_raises(Orb::APIConnectionError) do + assert_raises(Orb::Errors::APIConnectionError) do orb.customers.create(email: "dev@stainless.com", name: "x", request_options: {extra_headers: {}}) end @@ -224,7 +224,7 @@ def test_client_redirect_auth_keep_same_origin requester = MockRequester.new(307, {"location" => "/redirected"}, {}) orb.requester = requester - assert_raises(Orb::APIConnectionError) do + assert_raises(Orb::Errors::APIConnectionError) do orb.customers.create( email: "dev@stainless.com", name: "x", @@ -243,7 +243,7 @@ def test_client_redirect_auth_strip_cross_origin requester = MockRequester.new(307, {"location" => "https://example.com/redirected"}, {}) orb.requester = requester - assert_raises(Orb::APIConnectionError) do + assert_raises(Orb::Errors::APIConnectionError) do orb.customers.create( email: "dev@stainless.com", name: "x", diff --git a/test/orb/util_test.rb b/test/orb/util_test.rb index 938a3e60..1bd51e5d 100644 --- a/test/orb/util_test.rb +++ b/test/orb/util_test.rb @@ -233,7 +233,7 @@ def test_copy_write StringIO.new("abc") => "abc" } cases.each do |input, expected| - enum = Orb::Util.string_io do |y| + enum = Orb::Util.writable_enum do |y| IO.copy_stream(input, y) end assert_equal(expected, enum.to_a.join) From d97a657701038ad2e7645457fa63a878d04a6c25 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 2 Apr 2025 13:39:31 +0000 Subject: [PATCH 8/8] release: 0.1.0-alpha.32 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 18 ++++++++++++++++++ Gemfile.lock | 2 +- lib/orb/version.rb | 2 +- rbi/lib/orb/version.rbi | 2 +- 5 files changed, 22 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index a899ac74..2ce25fec 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.31" + ".": "0.1.0-alpha.32" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index af73f4ab..4b7a55cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,23 @@ # Changelog +## 0.1.0-alpha.32 (2025-04-02) + +Full Changelog: [v0.1.0-alpha.31...v0.1.0-alpha.32](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.31...v0.1.0-alpha.32) + +### Features + +* link response models to their methods in yard doc ([#198](https://github.com/orbcorp/orb-ruby/issues/198)) ([6f6cc29](https://github.com/orbcorp/orb-ruby/commit/6f6cc2972dd0f0863201d4d7642dbec922893364)) + + +### Chores + +* improve yard docs readability ([#197](https://github.com/orbcorp/orb-ruby/issues/197)) ([6416b4c](https://github.com/orbcorp/orb-ruby/commit/6416b4c1725c50e22dd7360ce0175651cc7b86fa)) +* **internal:** codegen related update ([#196](https://github.com/orbcorp/orb-ruby/issues/196)) ([d2e04d6](https://github.com/orbcorp/orb-ruby/commit/d2e04d695150fc6253f47f00693f9967a7fa69d4)) +* **internal:** codegen related update ([#199](https://github.com/orbcorp/orb-ruby/issues/199)) ([70d35b6](https://github.com/orbcorp/orb-ruby/commit/70d35b67ae45e59e17e3cbc8b490094b5e74ae75)) +* **internal:** codegen related update ([#201](https://github.com/orbcorp/orb-ruby/issues/201)) ([641222f](https://github.com/orbcorp/orb-ruby/commit/641222f1f19b2e4d14e7eabe8f9b4ef429fe02e9)) +* **internal:** version bump ([#194](https://github.com/orbcorp/orb-ruby/issues/194)) ([42ffeeb](https://github.com/orbcorp/orb-ruby/commit/42ffeebb1ea9141981bd5a92ad8268db02162d7b)) +* order client variables by "importance" ([#200](https://github.com/orbcorp/orb-ruby/issues/200)) ([59fb348](https://github.com/orbcorp/orb-ruby/commit/59fb348f33a4379778338d4f1791707713627a1e)) + ## 0.1.0-alpha.31 (2025-04-01) Full Changelog: [v0.1.0-alpha.30...v0.1.0-alpha.31](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.30...v0.1.0-alpha.31) diff --git a/Gemfile.lock b/Gemfile.lock index a0bfed98..8713e6d5 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - orb (0.1.0.pre.alpha.31) + orb (0.1.0.pre.alpha.32) connection_pool GEM diff --git a/lib/orb/version.rb b/lib/orb/version.rb index d545d7b2..f6beec54 100644 --- a/lib/orb/version.rb +++ b/lib/orb/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Orb - VERSION = "0.1.0-alpha.31" + VERSION = "0.1.0-alpha.32" end diff --git a/rbi/lib/orb/version.rbi b/rbi/lib/orb/version.rbi index 2bf97cc4..1b45b86c 100644 --- a/rbi/lib/orb/version.rbi +++ b/rbi/lib/orb/version.rbi @@ -1,5 +1,5 @@ # typed: strong module Orb - VERSION = "0.1.0-alpha.31" + VERSION = "0.1.0-alpha.32" end