orb-billing 0.5.2 → 0.5.3
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 +12 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- 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
@@ -23,7 +23,7 @@ module Orb
|
|
23
23
|
|
24
24
|
# @!attribute line_items
|
25
25
|
#
|
26
|
-
# @return [Array<Orb::InvoiceCreateParams::LineItem>]
|
26
|
+
# @return [Array<Orb::Models::InvoiceCreateParams::LineItem>]
|
27
27
|
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::InvoiceCreateParams::LineItem] }
|
28
28
|
|
29
29
|
# @!attribute net_terms
|
@@ -45,7 +45,7 @@ module Orb
|
|
45
45
|
# @!attribute discount
|
46
46
|
# An optional discount to attach to the invoice.
|
47
47
|
#
|
48
|
-
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
48
|
+
# @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
49
49
|
optional :discount, union: -> { Orb::Discount }, nil?: true
|
50
50
|
|
51
51
|
# @!attribute external_customer_id
|
@@ -85,13 +85,13 @@ module Orb
|
|
85
85
|
#
|
86
86
|
# @param invoice_date [Time] Optional invoice date to set. Must be in the past, if not set, `invoice_date` is
|
87
87
|
#
|
88
|
-
# @param line_items [Array<Orb::InvoiceCreateParams::LineItem>]
|
88
|
+
# @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
|
89
89
|
#
|
90
90
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
91
91
|
#
|
92
92
|
# @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e
|
93
93
|
#
|
94
|
-
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil] An optional discount to attach to the invoice.
|
94
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] An optional discount to attach to the invoice.
|
95
95
|
#
|
96
96
|
# @param external_customer_id [String, nil] The `external_customer_id` of the `Customer` to create this invoice for. One of
|
97
97
|
#
|
@@ -117,7 +117,7 @@ module Orb
|
|
117
117
|
|
118
118
|
# @!attribute model_type
|
119
119
|
#
|
120
|
-
# @return [Symbol, Orb::InvoiceCreateParams::LineItem::ModelType]
|
120
|
+
# @return [Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType]
|
121
121
|
required :model_type, enum: -> { Orb::InvoiceCreateParams::LineItem::ModelType }
|
122
122
|
|
123
123
|
# @!attribute name
|
@@ -140,7 +140,7 @@ module Orb
|
|
140
140
|
|
141
141
|
# @!attribute unit_config
|
142
142
|
#
|
143
|
-
# @return [Orb::InvoiceCreateParams::LineItem::UnitConfig]
|
143
|
+
# @return [Orb::Models::InvoiceCreateParams::LineItem::UnitConfig]
|
144
144
|
required :unit_config, -> { Orb::InvoiceCreateParams::LineItem::UnitConfig }
|
145
145
|
|
146
146
|
# @!method initialize(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:)
|
@@ -148,7 +148,7 @@ module Orb
|
|
148
148
|
#
|
149
149
|
# @param item_id [String]
|
150
150
|
#
|
151
|
-
# @param model_type [Symbol, Orb::InvoiceCreateParams::LineItem::ModelType]
|
151
|
+
# @param model_type [Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType]
|
152
152
|
#
|
153
153
|
# @param name [String] The name of the line item.
|
154
154
|
#
|
@@ -156,9 +156,9 @@ module Orb
|
|
156
156
|
#
|
157
157
|
# @param start_date [Date] A date string to specify the line item's start date in the customer's timezone.
|
158
158
|
#
|
159
|
-
# @param unit_config [Orb::InvoiceCreateParams::LineItem::UnitConfig]
|
159
|
+
# @param unit_config [Orb::Models::InvoiceCreateParams::LineItem::UnitConfig]
|
160
160
|
|
161
|
-
# @see Orb::InvoiceCreateParams::LineItem#model_type
|
161
|
+
# @see Orb::Models::InvoiceCreateParams::LineItem#model_type
|
162
162
|
module ModelType
|
163
163
|
extend Orb::Internal::Type::Enum
|
164
164
|
|
@@ -168,7 +168,7 @@ module Orb
|
|
168
168
|
# @return [Array<Symbol>]
|
169
169
|
end
|
170
170
|
|
171
|
-
# @see Orb::InvoiceCreateParams::LineItem#unit_config
|
171
|
+
# @see Orb::Models::InvoiceCreateParams::LineItem#unit_config
|
172
172
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
173
173
|
# @!attribute unit_amount
|
174
174
|
# Rate per unit of usage
|
@@ -178,7 +178,7 @@ module Orb
|
|
178
178
|
|
179
179
|
# @!attribute discounts
|
180
180
|
#
|
181
|
-
# @return [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
181
|
+
# @return [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
|
182
182
|
required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::InvoiceLevelDiscount] }
|
183
183
|
|
184
184
|
# @!attribute due_date
|
@@ -395,7 +395,7 @@ module Orb
|
|
395
395
|
#
|
396
396
|
# @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
|
397
397
|
#
|
398
|
-
# @param discounts [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
398
|
+
# @param discounts [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
|
399
399
|
#
|
400
400
|
# @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
|
401
401
|
#
|
@@ -1106,7 +1106,7 @@ module Orb
|
|
1106
1106
|
|
1107
1107
|
# @!attribute discount
|
1108
1108
|
#
|
1109
|
-
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1109
|
+
# @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
1110
1110
|
required :discount, union: -> { Orb::Discount }, nil?: true
|
1111
1111
|
|
1112
1112
|
# @!attribute end_date
|
@@ -1185,7 +1185,7 @@ module Orb
|
|
1185
1185
|
# For more on the types of prices, see
|
1186
1186
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1187
1187
|
#
|
1188
|
-
# @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, nil]
|
1188
|
+
# @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, nil]
|
1189
1189
|
required :price, union: -> { Orb::Price }, nil?: true
|
1190
1190
|
|
1191
1191
|
# @!attribute quantity
|
@@ -1242,7 +1242,7 @@ module Orb
|
|
1242
1242
|
#
|
1243
1243
|
# @param credits_applied [String] The number of prepaid credits applied.
|
1244
1244
|
#
|
1245
|
-
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1245
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
1246
1246
|
#
|
1247
1247
|
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
1248
1248
|
#
|
@@ -1262,7 +1262,7 @@ module Orb
|
|
1262
1262
|
#
|
1263
1263
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
1264
1264
|
#
|
1265
|
-
# @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, nil] The Price resource represents a price that can be billed on a subscription, resu
|
1265
|
+
# @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, nil] The Price resource represents a price that can be billed on a subscription, resu
|
1266
1266
|
#
|
1267
1267
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
1268
1268
|
#
|
@@ -14,7 +14,7 @@ module Orb
|
|
14
14
|
variant :trial, -> { Orb::TrialDiscount }
|
15
15
|
|
16
16
|
# @!method self.variants
|
17
|
-
# @return [Array(Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount)]
|
17
|
+
# @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount)]
|
18
18
|
end
|
19
19
|
end
|
20
20
|
end
|
@@ -41,7 +41,7 @@ module Orb
|
|
41
41
|
|
42
42
|
# @!attribute discount
|
43
43
|
#
|
44
|
-
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
44
|
+
# @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
45
45
|
required :discount, union: -> { Orb::Discount }, nil?: true
|
46
46
|
|
47
47
|
# @!attribute end_date
|
@@ -120,7 +120,7 @@ module Orb
|
|
120
120
|
# For more on the types of prices, see
|
121
121
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
122
122
|
#
|
123
|
-
# @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, nil]
|
123
|
+
# @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, nil]
|
124
124
|
required :price, union: -> { Orb::Price }, nil?: true
|
125
125
|
|
126
126
|
# @!attribute quantity
|
@@ -177,7 +177,7 @@ module Orb
|
|
177
177
|
#
|
178
178
|
# @param credits_applied [String] The number of prepaid credits applied.
|
179
179
|
#
|
180
|
-
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
180
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
181
181
|
#
|
182
182
|
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
183
183
|
#
|
@@ -197,7 +197,7 @@ module Orb
|
|
197
197
|
#
|
198
198
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
199
199
|
#
|
200
|
-
# @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, nil] The Price resource represents a price that can be billed on a subscription, resu
|
200
|
+
# @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, nil] The Price resource represents a price that can be billed on a subscription, resu
|
201
201
|
#
|
202
202
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
203
203
|
#
|
@@ -36,7 +36,7 @@ module Orb
|
|
36
36
|
|
37
37
|
# @!attribute date_type
|
38
38
|
#
|
39
|
-
# @return [Symbol, Orb::InvoiceListParams::DateType, nil]
|
39
|
+
# @return [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
|
40
40
|
optional :date_type, enum: -> { Orb::InvoiceListParams::DateType }, nil?: true
|
41
41
|
|
42
42
|
# @!attribute due_date
|
@@ -101,7 +101,7 @@ module Orb
|
|
101
101
|
|
102
102
|
# @!attribute status
|
103
103
|
#
|
104
|
-
# @return [Array<Symbol, Orb::InvoiceListParams::Status>, nil]
|
104
|
+
# @return [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
|
105
105
|
optional :status, -> { Orb::Internal::Type::ArrayOf[enum: Orb::InvoiceListParams::Status] }, nil?: true
|
106
106
|
|
107
107
|
# @!attribute subscription_id
|
@@ -123,7 +123,7 @@ module Orb
|
|
123
123
|
#
|
124
124
|
# @param customer_id [String, nil]
|
125
125
|
#
|
126
|
-
# @param date_type [Symbol, Orb::InvoiceListParams::DateType, nil]
|
126
|
+
# @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
|
127
127
|
#
|
128
128
|
# @param due_date [Date, nil]
|
129
129
|
#
|
@@ -147,7 +147,7 @@ module Orb
|
|
147
147
|
#
|
148
148
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
149
149
|
#
|
150
|
-
# @param status [Array<Symbol, Orb::InvoiceListParams::Status>, nil]
|
150
|
+
# @param status [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
|
151
151
|
#
|
152
152
|
# @param subscription_id [String, nil]
|
153
153
|
#
|
data/lib/orb/models/item.rb
CHANGED
@@ -16,7 +16,7 @@ module Orb
|
|
16
16
|
|
17
17
|
# @!attribute external_connections
|
18
18
|
#
|
19
|
-
# @return [Array<Orb::Item::ExternalConnection>]
|
19
|
+
# @return [Array<Orb::Models::Item::ExternalConnection>]
|
20
20
|
required :external_connections, -> { Orb::Internal::Type::ArrayOf[Orb::Item::ExternalConnection] }
|
21
21
|
|
22
22
|
# @!attribute name
|
@@ -31,13 +31,13 @@ module Orb
|
|
31
31
|
#
|
32
32
|
# @param id [String]
|
33
33
|
# @param created_at [Time]
|
34
|
-
# @param external_connections [Array<Orb::Item::ExternalConnection>]
|
34
|
+
# @param external_connections [Array<Orb::Models::Item::ExternalConnection>]
|
35
35
|
# @param name [String]
|
36
36
|
|
37
37
|
class ExternalConnection < Orb::Internal::Type::BaseModel
|
38
38
|
# @!attribute external_connection_name
|
39
39
|
#
|
40
|
-
# @return [Symbol, Orb::Item::ExternalConnection::ExternalConnectionName]
|
40
|
+
# @return [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName]
|
41
41
|
required :external_connection_name, enum: -> { Orb::Item::ExternalConnection::ExternalConnectionName }
|
42
42
|
|
43
43
|
# @!attribute external_entity_id
|
@@ -46,10 +46,10 @@ module Orb
|
|
46
46
|
required :external_entity_id, String
|
47
47
|
|
48
48
|
# @!method initialize(external_connection_name:, external_entity_id:)
|
49
|
-
# @param external_connection_name [Symbol, Orb::Item::ExternalConnection::ExternalConnectionName]
|
49
|
+
# @param external_connection_name [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName]
|
50
50
|
# @param external_entity_id [String]
|
51
51
|
|
52
|
-
# @see Orb::Item::ExternalConnection#external_connection_name
|
52
|
+
# @see Orb::Models::Item::ExternalConnection#external_connection_name
|
53
53
|
module ExternalConnectionName
|
54
54
|
extend Orb::Internal::Type::Enum
|
55
55
|
|
@@ -9,7 +9,7 @@ module Orb
|
|
9
9
|
|
10
10
|
# @!attribute external_connections
|
11
11
|
#
|
12
|
-
# @return [Array<Orb::ItemUpdateParams::ExternalConnection>, nil]
|
12
|
+
# @return [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
|
13
13
|
optional :external_connections,
|
14
14
|
-> { Orb::Internal::Type::ArrayOf[Orb::ItemUpdateParams::ExternalConnection] },
|
15
15
|
nil?: true
|
@@ -20,14 +20,14 @@ module Orb
|
|
20
20
|
optional :name, String, nil?: true
|
21
21
|
|
22
22
|
# @!method initialize(external_connections: nil, name: nil, request_options: {})
|
23
|
-
# @param external_connections [Array<Orb::ItemUpdateParams::ExternalConnection>, nil]
|
23
|
+
# @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
|
24
24
|
# @param name [String, nil]
|
25
25
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
26
26
|
|
27
27
|
class ExternalConnection < Orb::Internal::Type::BaseModel
|
28
28
|
# @!attribute external_connection_name
|
29
29
|
#
|
30
|
-
# @return [Symbol, Orb::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
|
30
|
+
# @return [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
|
31
31
|
required :external_connection_name,
|
32
32
|
enum: -> { Orb::ItemUpdateParams::ExternalConnection::ExternalConnectionName }
|
33
33
|
|
@@ -37,10 +37,10 @@ module Orb
|
|
37
37
|
required :external_entity_id, String
|
38
38
|
|
39
39
|
# @!method initialize(external_connection_name:, external_entity_id:)
|
40
|
-
# @param external_connection_name [Symbol, Orb::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
|
40
|
+
# @param external_connection_name [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
|
41
41
|
# @param external_entity_id [String]
|
42
42
|
|
43
|
-
# @see Orb::ItemUpdateParams::ExternalConnection#external_connection_name
|
43
|
+
# @see Orb::Models::ItemUpdateParams::ExternalConnection#external_connection_name
|
44
44
|
module ExternalConnectionName
|
45
45
|
extend Orb::Internal::Type::Enum
|
46
46
|
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute discount_type
|
14
14
|
#
|
15
|
-
# @return [Symbol, Orb::PercentageDiscount::DiscountType]
|
15
|
+
# @return [Symbol, Orb::Models::PercentageDiscount::DiscountType]
|
16
16
|
required :discount_type, enum: -> { Orb::PercentageDiscount::DiscountType }
|
17
17
|
|
18
18
|
# @!attribute percentage_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:, percentage_discount:, reason: nil)
|
31
|
-
# Some parameter documentations has been truncated, see
|
32
|
-
# for more details.
|
31
|
+
# Some parameter documentations has been truncated, see
|
32
|
+
# {Orb::Models::PercentageDiscount} 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::PercentageDiscount::DiscountType]
|
36
|
+
# @param discount_type [Symbol, Orb::Models::PercentageDiscount::DiscountType]
|
37
37
|
#
|
38
38
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`. This is a number between 0 and
|
39
39
|
#
|
40
40
|
# @param reason [String, nil]
|
41
41
|
|
42
|
-
# @see Orb::PercentageDiscount#discount_type
|
42
|
+
# @see Orb::Models::PercentageDiscount#discount_type
|
43
43
|
module DiscountType
|
44
44
|
extend Orb::Internal::Type::Enum
|
45
45
|
|