orb-billing 0.5.2 → 0.5.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +25 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal/util.rb +3 -1
- data/lib/orb/internal.rb +3 -0
- data/lib/orb/models/alert.rb +23 -23
- data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +5 -5
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +6 -6
- data/lib/orb/models/coupon_create_params.rb +3 -3
- data/lib/orb/models/credit_note.rb +33 -33
- data/lib/orb/models/credit_note_create_params.rb +4 -4
- data/lib/orb/models/customer.rb +39 -39
- data/lib/orb/models/customer_create_params.rb +26 -26
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -26
- data/lib/orb/models/customer_update_params.rb +26 -26
- data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/dimensional_price_groups.rb +4 -4
- data/lib/orb/models/discount.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +3 -3
- data/lib/orb/models/events/event_volumes.rb +2 -2
- data/lib/orb/models/invoice.rb +114 -113
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -6
- data/lib/orb/models/invoice_level_discount.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -4
- data/lib/orb/models/invoice_list_params.rb +4 -4
- data/lib/orb/models/item.rb +5 -5
- data/lib/orb/models/item_update_params.rb +5 -5
- data/lib/orb/models/percentage_discount.rb +5 -5
- data/lib/orb/models/plan.rb +58 -58
- data/lib/orb/models/plan_create_params.rb +448 -444
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1204
- data/lib/orb/models/price_create_params.rb +50 -50
- data/lib/orb/models/price_evaluate_response.rb +2 -2
- data/lib/orb/models/subscription.rb +58 -56
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_apply_response.rb +14 -14
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -14
- data/lib/orb/models/subscription_create_params.rb +1002 -987
- data/lib/orb/models/subscription_create_response.rb +14 -14
- data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
- data/lib/orb/models/subscription_list_params.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +596 -585
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -14
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -971
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -14
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -14
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -14
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -14
- data/lib/orb/models/subscription_usage.rb +26 -26
- data/lib/orb/models/subscriptions.rb +4 -4
- data/lib/orb/models/trial_discount.rb +5 -5
- data/lib/orb/models/usage_discount.rb +5 -5
- data/lib/orb/resources/alerts.rb +15 -15
- data/lib/orb/resources/coupons/subscriptions.rb +1 -1
- data/lib/orb/resources/coupons.rb +5 -5
- data/lib/orb/resources/credit_notes.rb +5 -5
- data/lib/orb/resources/customers/balance_transactions.rb +1 -1
- data/lib/orb/resources/customers/costs.rb +2 -2
- data/lib/orb/resources/customers/credits/ledger.rb +10 -10
- data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
- data/lib/orb/resources/customers.rb +30 -30
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
- data/lib/orb/resources/dimensional_price_groups.rb +3 -3
- data/lib/orb/resources/events/volume.rb +1 -1
- data/lib/orb/resources/events.rb +1 -1
- data/lib/orb/resources/invoices.rb +12 -12
- data/lib/orb/resources/items.rb +5 -5
- data/lib/orb/resources/metrics.rb +4 -4
- data/lib/orb/resources/plans/external_plan_id.rb +2 -2
- data/lib/orb/resources/plans.rb +7 -7
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +17 -17
- data/lib/orb/resources/subscriptions.rb +32 -32
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +26 -72
- data/rbi/orb/models/subscription_update_trial_params.rbi +14 -3
- data/rbi/orb/resources/subscriptions.rbi +4 -1
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +32 -4
- data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
- data/sig/orb/models/alert_disable_params.rbs +5 -0
- data/sig/orb/models/alert_enable_params.rbs +5 -0
- data/sig/orb/models/alert_list_params.rbs +13 -0
- data/sig/orb/models/alert_retrieve_params.rbs +2 -0
- data/sig/orb/models/alert_update_params.rbs +7 -0
- data/sig/orb/models/amount_discount.rbs +11 -4
- data/sig/orb/models/billable_metric.rbs +13 -4
- data/sig/orb/models/coupon.rbs +14 -4
- data/sig/orb/models/coupon_archive_params.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +15 -0
- data/sig/orb/models/coupon_fetch_params.rbs +2 -0
- data/sig/orb/models/coupon_list_params.rbs +8 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
- data/sig/orb/models/credit_note.rbs +88 -20
- data/sig/orb/models/credit_note_create_params.rbs +9 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
- data/sig/orb/models/credit_note_list_params.rbs +10 -0
- data/sig/orb/models/customer.rbs +86 -16
- data/sig/orb/models/customer_create_params.rbs +79 -8
- data/sig/orb/models/customer_delete_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_params.rbs +2 -0
- data/sig/orb/models/customer_list_params.rbs +10 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
- data/sig/orb/models/customer_update_params.rbs +78 -8
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
- data/sig/orb/models/customers/cost_list_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_response.rbs +20 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
- data/sig/orb/models/customers/credit_list_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_response.rbs +10 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
- data/sig/orb/models/dimensional_price_group.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups.rbs +5 -0
- data/sig/orb/models/evaluate_price_group.rbs +10 -4
- data/sig/orb/models/event_deprecate_params.rbs +2 -0
- data/sig/orb/models/event_deprecate_response.rbs +2 -0
- data/sig/orb/models/event_ingest_params.rbs +16 -0
- data/sig/orb/models/event_ingest_response.rbs +15 -0
- data/sig/orb/models/event_search_params.rbs +7 -0
- data/sig/orb/models/event_search_response.rbs +12 -0
- data/sig/orb/models/event_update_params.rbs +9 -0
- data/sig/orb/models/event_update_response.rbs +2 -0
- data/sig/orb/models/events/backfill_close_params.rbs +2 -0
- data/sig/orb/models/events/backfill_close_response.rbs +14 -0
- data/sig/orb/models/events/backfill_create_params.rbs +11 -0
- data/sig/orb/models/events/backfill_create_response.rbs +14 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
- data/sig/orb/models/events/backfill_list_params.rbs +6 -0
- data/sig/orb/models/events/backfill_list_response.rbs +14 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
- data/sig/orb/models/events/event_volumes.rbs +8 -0
- data/sig/orb/models/events/volume_list_params.rbs +8 -0
- data/sig/orb/models/invoice.rbs +293 -36
- data/sig/orb/models/invoice_create_params.rbs +30 -4
- data/sig/orb/models/invoice_fetch_params.rbs +2 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
- data/sig/orb/models/invoice_issue_params.rbs +5 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
- data/sig/orb/models/invoice_list_params.rbs +27 -4
- data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
- data/sig/orb/models/invoice_pay_params.rbs +2 -0
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +2 -0
- data/sig/orb/models/item.rbs +16 -4
- data/sig/orb/models/item_create_params.rbs +2 -0
- data/sig/orb/models/item_fetch_params.rbs +2 -0
- data/sig/orb/models/item_list_params.rbs +6 -0
- data/sig/orb/models/item_update_params.rbs +15 -4
- data/sig/orb/models/metric_create_params.rbs +9 -0
- data/sig/orb/models/metric_fetch_params.rbs +2 -0
- data/sig/orb/models/metric_list_params.rbs +10 -0
- data/sig/orb/models/metric_update_params.rbs +5 -0
- data/sig/orb/models/pagination_metadata.rbs +2 -0
- data/sig/orb/models/percentage_discount.rbs +11 -4
- data/sig/orb/models/plan.rbs +141 -16
- data/sig/orb/models/plan_create_params.rbs +1070 -304
- data/sig/orb/models/plan_fetch_params.rbs +2 -0
- data/sig/orb/models/plan_list_params.rbs +11 -0
- data/sig/orb/models/plan_update_params.rbs +6 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
- data/sig/orb/models/price.rbs +2148 -460
- data/sig/orb/models/price_create_params.rbs +130 -8
- data/sig/orb/models/price_evaluate_params.rbs +10 -0
- data/sig/orb/models/price_evaluate_response.rbs +2 -0
- data/sig/orb/models/price_fetch_params.rbs +2 -0
- data/sig/orb/models/price_list_params.rbs +6 -0
- data/sig/orb/models/price_update_params.rbs +5 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
- data/sig/orb/models/subscription.rbs +177 -12
- data/sig/orb/models/subscription_cancel_params.rbs +7 -0
- data/sig/orb/models/subscription_cancel_response.rbs +173 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
- data/sig/orb/models/subscription_create_params.rbs +2368 -632
- data/sig/orb/models/subscription_create_response.rbs +173 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
- data/sig/orb/models/subscription_fetch_params.rbs +2 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
- data/sig/orb/models/subscription_list_params.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
- data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
- data/sig/orb/models/subscription_update_params.rbs +9 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
- data/sig/orb/models/subscription_usage.rbs +48 -8
- data/sig/orb/models/subscriptions.rbs +5 -0
- data/sig/orb/models/top_level_ping_params.rbs +2 -0
- data/sig/orb/models/top_level_ping_response.rbs +2 -0
- data/sig/orb/models/trial_discount.rbs +12 -4
- data/sig/orb/models/usage_discount.rbs +11 -4
- data/sig/orb/resources/invoices.rbs +1 -1
- data/sig/orb/resources/plans.rbs +1 -1
- metadata +2 -2
@@ -88,7 +88,7 @@ module Orb
|
|
88
88
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
89
|
# information on what this timezone parameter influences within Orb.
|
90
90
|
#
|
91
|
-
# @return [Orb::Customer]
|
91
|
+
# @return [Orb::Models::Customer]
|
92
92
|
required :customer, -> { Orb::Customer }
|
93
93
|
|
94
94
|
# @!attribute default_invoice_memo
|
@@ -168,7 +168,7 @@ module Orb
|
|
168
168
|
# subscription. You can see more about how to configure prices in the
|
169
169
|
# [Price resource](/reference/price).
|
170
170
|
#
|
171
|
-
# @return [Orb::Plan]
|
171
|
+
# @return [Orb::Models::Plan]
|
172
172
|
required :plan, -> { Orb::Plan }
|
173
173
|
|
174
174
|
# @!attribute price_intervals
|
@@ -233,7 +233,7 @@ module Orb
|
|
233
233
|
#
|
234
234
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
235
235
|
#
|
236
|
-
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
236
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
237
237
|
#
|
238
238
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
239
239
|
#
|
@@ -255,7 +255,7 @@ module Orb
|
|
255
255
|
#
|
256
256
|
# @param pending_subscription_change [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
257
257
|
#
|
258
|
-
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
258
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
259
259
|
#
|
260
260
|
# @param price_intervals [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval>] The price intervals for this subscription.
|
261
261
|
#
|
@@ -1072,7 +1072,7 @@ module Orb
|
|
1072
1072
|
# For more on the types of prices, see
|
1073
1073
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1074
1074
|
#
|
1075
|
-
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1075
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1076
1076
|
required :price, union: -> { Orb::Price }
|
1077
1077
|
|
1078
1078
|
# @!attribute start_date
|
@@ -1112,7 +1112,7 @@ module Orb
|
|
1112
1112
|
#
|
1113
1113
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1114
1114
|
#
|
1115
|
-
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1115
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1116
1116
|
#
|
1117
1117
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1118
1118
|
#
|
@@ -1192,25 +1192,25 @@ module Orb
|
|
1192
1192
|
# @!attribute created_credit_notes
|
1193
1193
|
# The credit notes that were created as part of this operation.
|
1194
1194
|
#
|
1195
|
-
# @return [Array<Orb::CreditNote>]
|
1195
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1196
1196
|
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1197
1197
|
|
1198
1198
|
# @!attribute created_invoices
|
1199
1199
|
# The invoices that were created as part of this operation.
|
1200
1200
|
#
|
1201
|
-
# @return [Array<Orb::Invoice>]
|
1201
|
+
# @return [Array<Orb::Models::Invoice>]
|
1202
1202
|
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1203
1203
|
|
1204
1204
|
# @!attribute voided_credit_notes
|
1205
1205
|
# The credit notes that were voided as part of this operation.
|
1206
1206
|
#
|
1207
|
-
# @return [Array<Orb::CreditNote>]
|
1207
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1208
1208
|
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1209
1209
|
|
1210
1210
|
# @!attribute voided_invoices
|
1211
1211
|
# The invoices that were voided as part of this operation.
|
1212
1212
|
#
|
1213
|
-
# @return [Array<Orb::Invoice>]
|
1213
|
+
# @return [Array<Orb::Models::Invoice>]
|
1214
1214
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1215
1215
|
|
1216
1216
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
@@ -1218,13 +1218,13 @@ module Orb
|
|
1218
1218
|
# fetched through the subscription changes API or if the
|
1219
1219
|
# `include_changed_resources` parameter was passed in the request.
|
1220
1220
|
#
|
1221
|
-
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1221
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1222
1222
|
#
|
1223
|
-
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1223
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1224
1224
|
#
|
1225
|
-
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1225
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1226
1226
|
#
|
1227
|
-
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1227
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1228
1228
|
end
|
1229
1229
|
end
|
1230
1230
|
end
|
@@ -11,7 +11,7 @@ module Orb
|
|
11
11
|
# The new date that the trial should end, or the literal string `immediate` to end
|
12
12
|
# the trial immediately.
|
13
13
|
#
|
14
|
-
# @return [Time, Symbol, Orb::SubscriptionUpdateTrialParams::TrialEndDate]
|
14
|
+
# @return [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate]
|
15
15
|
required :trial_end_date, union: -> { Orb::SubscriptionUpdateTrialParams::TrialEndDate }
|
16
16
|
|
17
17
|
# @!attribute shift
|
@@ -25,7 +25,7 @@ module Orb
|
|
25
25
|
# Some parameter documentations has been truncated, see
|
26
26
|
# {Orb::Models::SubscriptionUpdateTrialParams} for more details.
|
27
27
|
#
|
28
|
-
# @param trial_end_date [Time, Symbol, Orb::SubscriptionUpdateTrialParams::TrialEndDate] The new date that the trial should end, or the literal string `immediate` to end
|
28
|
+
# @param trial_end_date [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] The new date that the trial should end, or the literal string `immediate` to end
|
29
29
|
#
|
30
30
|
# @param shift [Boolean] If true, shifts subsequent price and adjustment intervals (preserving their dura
|
31
31
|
#
|
@@ -38,7 +38,7 @@ module Orb
|
|
38
38
|
|
39
39
|
variant Time
|
40
40
|
|
41
|
-
variant const: -> { Orb::SubscriptionUpdateTrialParams::TrialEndDate::IMMEDIATE }
|
41
|
+
variant const: -> { Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::IMMEDIATE }
|
42
42
|
|
43
43
|
# @!method self.variants
|
44
44
|
# @return [Array(Time, Symbol)]
|
@@ -88,7 +88,7 @@ module Orb
|
|
88
88
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
89
|
# information on what this timezone parameter influences within Orb.
|
90
90
|
#
|
91
|
-
# @return [Orb::Customer]
|
91
|
+
# @return [Orb::Models::Customer]
|
92
92
|
required :customer, -> { Orb::Customer }
|
93
93
|
|
94
94
|
# @!attribute default_invoice_memo
|
@@ -168,7 +168,7 @@ module Orb
|
|
168
168
|
# subscription. You can see more about how to configure prices in the
|
169
169
|
# [Price resource](/reference/price).
|
170
170
|
#
|
171
|
-
# @return [Orb::Plan]
|
171
|
+
# @return [Orb::Models::Plan]
|
172
172
|
required :plan, -> { Orb::Plan }
|
173
173
|
|
174
174
|
# @!attribute price_intervals
|
@@ -231,7 +231,7 @@ module Orb
|
|
231
231
|
#
|
232
232
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
233
233
|
#
|
234
|
-
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
234
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
235
235
|
#
|
236
236
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
237
237
|
#
|
@@ -253,7 +253,7 @@ module Orb
|
|
253
253
|
#
|
254
254
|
# @param pending_subscription_change [Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
255
255
|
#
|
256
|
-
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
256
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
257
257
|
#
|
258
258
|
# @param price_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval>] The price intervals for this subscription.
|
259
259
|
#
|
@@ -1069,7 +1069,7 @@ module Orb
|
|
1069
1069
|
# For more on the types of prices, see
|
1070
1070
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1071
1071
|
#
|
1072
|
-
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1072
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1073
1073
|
required :price, union: -> { Orb::Price }
|
1074
1074
|
|
1075
1075
|
# @!attribute start_date
|
@@ -1108,7 +1108,7 @@ module Orb
|
|
1108
1108
|
#
|
1109
1109
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1110
1110
|
#
|
1111
|
-
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1111
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1112
1112
|
#
|
1113
1113
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1114
1114
|
#
|
@@ -1188,25 +1188,25 @@ module Orb
|
|
1188
1188
|
# @!attribute created_credit_notes
|
1189
1189
|
# The credit notes that were created as part of this operation.
|
1190
1190
|
#
|
1191
|
-
# @return [Array<Orb::CreditNote>]
|
1191
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1192
1192
|
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1193
1193
|
|
1194
1194
|
# @!attribute created_invoices
|
1195
1195
|
# The invoices that were created as part of this operation.
|
1196
1196
|
#
|
1197
|
-
# @return [Array<Orb::Invoice>]
|
1197
|
+
# @return [Array<Orb::Models::Invoice>]
|
1198
1198
|
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1199
1199
|
|
1200
1200
|
# @!attribute voided_credit_notes
|
1201
1201
|
# The credit notes that were voided as part of this operation.
|
1202
1202
|
#
|
1203
|
-
# @return [Array<Orb::CreditNote>]
|
1203
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1204
1204
|
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1205
1205
|
|
1206
1206
|
# @!attribute voided_invoices
|
1207
1207
|
# The invoices that were voided as part of this operation.
|
1208
1208
|
#
|
1209
|
-
# @return [Array<Orb::Invoice>]
|
1209
|
+
# @return [Array<Orb::Models::Invoice>]
|
1210
1210
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1211
1211
|
|
1212
1212
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
@@ -1214,13 +1214,13 @@ module Orb
|
|
1214
1214
|
# fetched through the subscription changes API or if the
|
1215
1215
|
# `include_changed_resources` parameter was passed in the request.
|
1216
1216
|
#
|
1217
|
-
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1217
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1218
1218
|
#
|
1219
|
-
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1219
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1220
1220
|
#
|
1221
|
-
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1221
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1222
1222
|
#
|
1223
|
-
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1223
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1224
1224
|
end
|
1225
1225
|
end
|
1226
1226
|
end
|
@@ -13,17 +13,17 @@ module Orb
|
|
13
13
|
class UngroupedSubscriptionUsage < Orb::Internal::Type::BaseModel
|
14
14
|
# @!attribute data
|
15
15
|
#
|
16
|
-
# @return [Array<Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
|
16
|
+
# @return [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
|
17
17
|
required :data,
|
18
18
|
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data] }
|
19
19
|
|
20
20
|
# @!method initialize(data:)
|
21
|
-
# @param data [Array<Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
|
21
|
+
# @param data [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
|
22
22
|
|
23
23
|
class Data < Orb::Internal::Type::BaseModel
|
24
24
|
# @!attribute billable_metric
|
25
25
|
#
|
26
|
-
# @return [Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
|
26
|
+
# @return [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
|
27
27
|
required :billable_metric,
|
28
28
|
-> {
|
29
29
|
Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric
|
@@ -31,7 +31,7 @@ module Orb
|
|
31
31
|
|
32
32
|
# @!attribute usage
|
33
33
|
#
|
34
|
-
# @return [Array<Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
|
34
|
+
# @return [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
|
35
35
|
required :usage,
|
36
36
|
-> {
|
37
37
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage]
|
@@ -39,15 +39,15 @@ module Orb
|
|
39
39
|
|
40
40
|
# @!attribute view_mode
|
41
41
|
#
|
42
|
-
# @return [Symbol, Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
|
42
|
+
# @return [Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
|
43
43
|
required :view_mode, enum: -> { Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode }
|
44
44
|
|
45
45
|
# @!method initialize(billable_metric:, usage:, view_mode:)
|
46
|
-
# @param billable_metric [Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
|
47
|
-
# @param usage [Array<Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
|
48
|
-
# @param view_mode [Symbol, Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
|
46
|
+
# @param billable_metric [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
|
47
|
+
# @param usage [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
|
48
|
+
# @param view_mode [Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
|
49
49
|
|
50
|
-
# @see Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data#billable_metric
|
50
|
+
# @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#billable_metric
|
51
51
|
class BillableMetric < Orb::Internal::Type::BaseModel
|
52
52
|
# @!attribute id
|
53
53
|
#
|
@@ -86,7 +86,7 @@ module Orb
|
|
86
86
|
# @param timeframe_start [Time]
|
87
87
|
end
|
88
88
|
|
89
|
-
# @see Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data#view_mode
|
89
|
+
# @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#view_mode
|
90
90
|
module ViewMode
|
91
91
|
extend Orb::Internal::Type::Enum
|
92
92
|
|
@@ -102,23 +102,23 @@ module Orb
|
|
102
102
|
class GroupedSubscriptionUsage < Orb::Internal::Type::BaseModel
|
103
103
|
# @!attribute data
|
104
104
|
#
|
105
|
-
# @return [Array<Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
|
105
|
+
# @return [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
|
106
106
|
required :data,
|
107
107
|
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data] }
|
108
108
|
|
109
109
|
# @!attribute pagination_metadata
|
110
110
|
#
|
111
|
-
# @return [Orb::PaginationMetadata, nil]
|
111
|
+
# @return [Orb::Models::PaginationMetadata, nil]
|
112
112
|
optional :pagination_metadata, -> { Orb::PaginationMetadata }, nil?: true
|
113
113
|
|
114
114
|
# @!method initialize(data:, pagination_metadata: nil)
|
115
|
-
# @param data [Array<Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
|
116
|
-
# @param pagination_metadata [Orb::PaginationMetadata, nil]
|
115
|
+
# @param data [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
|
116
|
+
# @param pagination_metadata [Orb::Models::PaginationMetadata, nil]
|
117
117
|
|
118
118
|
class Data < Orb::Internal::Type::BaseModel
|
119
119
|
# @!attribute billable_metric
|
120
120
|
#
|
121
|
-
# @return [Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
|
121
|
+
# @return [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
|
122
122
|
required :billable_metric,
|
123
123
|
-> {
|
124
124
|
Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric
|
@@ -126,12 +126,12 @@ module Orb
|
|
126
126
|
|
127
127
|
# @!attribute metric_group
|
128
128
|
#
|
129
|
-
# @return [Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
|
129
|
+
# @return [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
|
130
130
|
required :metric_group, -> { Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup }
|
131
131
|
|
132
132
|
# @!attribute usage
|
133
133
|
#
|
134
|
-
# @return [Array<Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
|
134
|
+
# @return [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
|
135
135
|
required :usage,
|
136
136
|
-> {
|
137
137
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage]
|
@@ -139,16 +139,16 @@ module Orb
|
|
139
139
|
|
140
140
|
# @!attribute view_mode
|
141
141
|
#
|
142
|
-
# @return [Symbol, Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
|
142
|
+
# @return [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
|
143
143
|
required :view_mode, enum: -> { Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode }
|
144
144
|
|
145
145
|
# @!method initialize(billable_metric:, metric_group:, usage:, view_mode:)
|
146
|
-
# @param billable_metric [Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
|
147
|
-
# @param metric_group [Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
|
148
|
-
# @param usage [Array<Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
|
149
|
-
# @param view_mode [Symbol, Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
|
146
|
+
# @param billable_metric [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
|
147
|
+
# @param metric_group [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
|
148
|
+
# @param usage [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
|
149
|
+
# @param view_mode [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
|
150
150
|
|
151
|
-
# @see Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data#billable_metric
|
151
|
+
# @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#billable_metric
|
152
152
|
class BillableMetric < Orb::Internal::Type::BaseModel
|
153
153
|
# @!attribute id
|
154
154
|
#
|
@@ -165,7 +165,7 @@ module Orb
|
|
165
165
|
# @param name [String]
|
166
166
|
end
|
167
167
|
|
168
|
-
# @see Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data#metric_group
|
168
|
+
# @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#metric_group
|
169
169
|
class MetricGroup < Orb::Internal::Type::BaseModel
|
170
170
|
# @!attribute property_key
|
171
171
|
#
|
@@ -204,7 +204,7 @@ module Orb
|
|
204
204
|
# @param timeframe_start [Time]
|
205
205
|
end
|
206
206
|
|
207
|
-
# @see Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data#view_mode
|
207
|
+
# @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#view_mode
|
208
208
|
module ViewMode
|
209
209
|
extend Orb::Internal::Type::Enum
|
210
210
|
|
@@ -218,7 +218,7 @@ module Orb
|
|
218
218
|
end
|
219
219
|
|
220
220
|
# @!method self.variants
|
221
|
-
# @return [Array(Orb::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::SubscriptionUsage::GroupedSubscriptionUsage)]
|
221
|
+
# @return [Array(Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage)]
|
222
222
|
end
|
223
223
|
end
|
224
224
|
end
|
@@ -5,17 +5,17 @@ module Orb
|
|
5
5
|
class SubscriptionsAPI < Orb::Internal::Type::BaseModel
|
6
6
|
# @!attribute data
|
7
7
|
#
|
8
|
-
# @return [Array<Orb::Subscription>]
|
8
|
+
# @return [Array<Orb::Models::Subscription>]
|
9
9
|
required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription] }
|
10
10
|
|
11
11
|
# @!attribute pagination_metadata
|
12
12
|
#
|
13
|
-
# @return [Orb::PaginationMetadata]
|
13
|
+
# @return [Orb::Models::PaginationMetadata]
|
14
14
|
required :pagination_metadata, -> { Orb::PaginationMetadata }
|
15
15
|
|
16
16
|
# @!method initialize(data:, pagination_metadata:)
|
17
|
-
# @param data [Array<Orb::Subscription>]
|
18
|
-
# @param pagination_metadata [Orb::PaginationMetadata]
|
17
|
+
# @param data [Array<Orb::Models::Subscription>]
|
18
|
+
# @param pagination_metadata [Orb::Models::PaginationMetadata]
|
19
19
|
end
|
20
20
|
end
|
21
21
|
end
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute discount_type
|
14
14
|
#
|
15
|
-
# @return [Symbol, Orb::TrialDiscount::DiscountType]
|
15
|
+
# @return [Symbol, Orb::Models::TrialDiscount::DiscountType]
|
16
16
|
required :discount_type, enum: -> { Orb::TrialDiscount::DiscountType }
|
17
17
|
|
18
18
|
# @!attribute reason
|
@@ -33,12 +33,12 @@ module Orb
|
|
33
33
|
optional :trial_percentage_discount, Float, nil?: true
|
34
34
|
|
35
35
|
# @!method initialize(applies_to_price_ids:, discount_type:, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil)
|
36
|
-
# Some parameter documentations has been truncated, see
|
37
|
-
# more details.
|
36
|
+
# Some parameter documentations has been truncated, see
|
37
|
+
# {Orb::Models::TrialDiscount} for more details.
|
38
38
|
#
|
39
39
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
|
40
40
|
#
|
41
|
-
# @param discount_type [Symbol, Orb::TrialDiscount::DiscountType]
|
41
|
+
# @param discount_type [Symbol, Orb::Models::TrialDiscount::DiscountType]
|
42
42
|
#
|
43
43
|
# @param reason [String, nil]
|
44
44
|
#
|
@@ -46,7 +46,7 @@ module Orb
|
|
46
46
|
#
|
47
47
|
# @param trial_percentage_discount [Float, nil] Only available if discount_type is `trial`
|
48
48
|
|
49
|
-
# @see Orb::TrialDiscount#discount_type
|
49
|
+
# @see Orb::Models::TrialDiscount#discount_type
|
50
50
|
module DiscountType
|
51
51
|
extend Orb::Internal::Type::Enum
|
52
52
|
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute discount_type
|
14
14
|
#
|
15
|
-
# @return [Symbol, Orb::UsageDiscount::DiscountType]
|
15
|
+
# @return [Symbol, Orb::Models::UsageDiscount::DiscountType]
|
16
16
|
required :discount_type, enum: -> { Orb::UsageDiscount::DiscountType }
|
17
17
|
|
18
18
|
# @!attribute usage_discount
|
@@ -28,18 +28,18 @@ module Orb
|
|
28
28
|
optional :reason, String, nil?: true
|
29
29
|
|
30
30
|
# @!method initialize(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil)
|
31
|
-
# Some parameter documentations has been truncated, see
|
32
|
-
# more details.
|
31
|
+
# Some parameter documentations has been truncated, see
|
32
|
+
# {Orb::Models::UsageDiscount} for more details.
|
33
33
|
#
|
34
34
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
|
35
35
|
#
|
36
|
-
# @param discount_type [Symbol, Orb::UsageDiscount::DiscountType]
|
36
|
+
# @param discount_type [Symbol, Orb::Models::UsageDiscount::DiscountType]
|
37
37
|
#
|
38
38
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
39
39
|
#
|
40
40
|
# @param reason [String, nil]
|
41
41
|
|
42
|
-
# @see Orb::UsageDiscount#discount_type
|
42
|
+
# @see Orb::Models::UsageDiscount#discount_type
|
43
43
|
module DiscountType
|
44
44
|
extend Orb::Internal::Type::Enum
|
45
45
|
|
data/lib/orb/resources/alerts.rb
CHANGED
@@ -10,7 +10,7 @@ module Orb
|
|
10
10
|
# @param alert_id [String]
|
11
11
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
12
12
|
#
|
13
|
-
# @return [Orb::Alert]
|
13
|
+
# @return [Orb::Models::Alert]
|
14
14
|
#
|
15
15
|
# @see Orb::Models::AlertRetrieveParams
|
16
16
|
def retrieve(alert_id, params = {})
|
@@ -28,11 +28,11 @@ module Orb
|
|
28
28
|
#
|
29
29
|
# @param alert_configuration_id [String]
|
30
30
|
#
|
31
|
-
# @param thresholds [Array<Orb::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
31
|
+
# @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
32
32
|
#
|
33
33
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
34
34
|
#
|
35
|
-
# @return [Orb::Alert]
|
35
|
+
# @return [Orb::Models::Alert]
|
36
36
|
#
|
37
37
|
# @see Orb::Models::AlertUpdateParams
|
38
38
|
def update(alert_configuration_id, params)
|
@@ -83,7 +83,7 @@ module Orb
|
|
83
83
|
#
|
84
84
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
85
85
|
#
|
86
|
-
# @return [Orb::Internal::Page<Orb::Alert>]
|
86
|
+
# @return [Orb::Internal::Page<Orb::Models::Alert>]
|
87
87
|
#
|
88
88
|
# @see Orb::Models::AlertListParams
|
89
89
|
def list(params = {})
|
@@ -118,13 +118,13 @@ module Orb
|
|
118
118
|
#
|
119
119
|
# @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
|
120
120
|
#
|
121
|
-
# @param type [Symbol, Orb::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
121
|
+
# @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
122
122
|
#
|
123
|
-
# @param thresholds [Array<Orb::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
123
|
+
# @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
124
124
|
#
|
125
125
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
126
126
|
#
|
127
|
-
# @return [Orb::Alert]
|
127
|
+
# @return [Orb::Models::Alert]
|
128
128
|
#
|
129
129
|
# @see Orb::Models::AlertCreateForCustomerParams
|
130
130
|
def create_for_customer(customer_id, params)
|
@@ -153,13 +153,13 @@ module Orb
|
|
153
153
|
#
|
154
154
|
# @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
|
155
155
|
#
|
156
|
-
# @param type [Symbol, Orb::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
156
|
+
# @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
|
157
157
|
#
|
158
|
-
# @param thresholds [Array<Orb::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
158
|
+
# @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
|
159
159
|
#
|
160
160
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
161
161
|
#
|
162
|
-
# @return [Orb::Alert]
|
162
|
+
# @return [Orb::Models::Alert]
|
163
163
|
#
|
164
164
|
# @see Orb::Models::AlertCreateForExternalCustomerParams
|
165
165
|
def create_for_external_customer(external_customer_id, params)
|
@@ -189,15 +189,15 @@ module Orb
|
|
189
189
|
#
|
190
190
|
# @param subscription_id [String]
|
191
191
|
#
|
192
|
-
# @param thresholds [Array<Orb::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
192
|
+
# @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
|
193
193
|
#
|
194
|
-
# @param type [Symbol, Orb::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
|
194
|
+
# @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
|
195
195
|
#
|
196
196
|
# @param metric_id [String, nil] The metric to track usage for.
|
197
197
|
#
|
198
198
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
199
199
|
#
|
200
|
-
# @return [Orb::Alert]
|
200
|
+
# @return [Orb::Models::Alert]
|
201
201
|
#
|
202
202
|
# @see Orb::Models::AlertCreateForSubscriptionParams
|
203
203
|
def create_for_subscription(subscription_id, params)
|
@@ -223,7 +223,7 @@ module Orb
|
|
223
223
|
#
|
224
224
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
225
225
|
#
|
226
|
-
# @return [Orb::Alert]
|
226
|
+
# @return [Orb::Models::Alert]
|
227
227
|
#
|
228
228
|
# @see Orb::Models::AlertDisableParams
|
229
229
|
def disable(alert_configuration_id, params = {})
|
@@ -249,7 +249,7 @@ module Orb
|
|
249
249
|
#
|
250
250
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
251
251
|
#
|
252
|
-
# @return [Orb::Alert]
|
252
|
+
# @return [Orb::Models::Alert]
|
253
253
|
#
|
254
254
|
# @see Orb::Models::AlertEnableParams
|
255
255
|
def enable(alert_configuration_id, params = {})
|
@@ -22,7 +22,7 @@ module Orb
|
|
22
22
|
#
|
23
23
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
24
24
|
#
|
25
|
-
# @return [Orb::Internal::Page<Orb::Subscription>]
|
25
|
+
# @return [Orb::Internal::Page<Orb::Models::Subscription>]
|
26
26
|
#
|
27
27
|
# @see Orb::Models::Coupons::SubscriptionListParams
|
28
28
|
def list(coupon_id, params = {})
|
@@ -14,7 +14,7 @@ module Orb
|
|
14
14
|
#
|
15
15
|
# @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {})
|
16
16
|
#
|
17
|
-
# @param discount [Orb::CouponCreateParams::Discount::Percentage, Orb::CouponCreateParams::Discount::Amount]
|
17
|
+
# @param discount [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
|
18
18
|
#
|
19
19
|
# @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
|
20
20
|
#
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
#
|
25
25
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
26
26
|
#
|
27
|
-
# @return [Orb::Coupon]
|
27
|
+
# @return [Orb::Models::Coupon]
|
28
28
|
#
|
29
29
|
# @see Orb::Models::CouponCreateParams
|
30
30
|
def create(params)
|
@@ -54,7 +54,7 @@ module Orb
|
|
54
54
|
#
|
55
55
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
56
56
|
#
|
57
|
-
# @return [Orb::Internal::Page<Orb::Coupon>]
|
57
|
+
# @return [Orb::Internal::Page<Orb::Models::Coupon>]
|
58
58
|
#
|
59
59
|
# @see Orb::Models::CouponListParams
|
60
60
|
def list(params = {})
|
@@ -78,7 +78,7 @@ module Orb
|
|
78
78
|
# @param coupon_id [String]
|
79
79
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
80
80
|
#
|
81
|
-
# @return [Orb::Coupon]
|
81
|
+
# @return [Orb::Models::Coupon]
|
82
82
|
#
|
83
83
|
# @see Orb::Models::CouponArchiveParams
|
84
84
|
def archive(coupon_id, params = {})
|
@@ -99,7 +99,7 @@ module Orb
|
|
99
99
|
# @param coupon_id [String]
|
100
100
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
101
101
|
#
|
102
|
-
# @return [Orb::Coupon]
|
102
|
+
# @return [Orb::Models::Coupon]
|
103
103
|
#
|
104
104
|
# @see Orb::Models::CouponFetchParams
|
105
105
|
def fetch(coupon_id, params = {})
|