orb-billing 0.5.5 → 0.7.0
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 +26 -0
- data/README.md +1 -1
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/type/base_model.rb +2 -2
- data/lib/orb/internal/type/union.rb +6 -6
- data/lib/orb/models/alert.rb +33 -1
- data/lib/orb/models/amount_discount.rb +10 -10
- data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +17940 -0
- data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +22 -0
- data/lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb +24 -0
- data/lib/orb/models/beta_create_plan_version_params.rb +17758 -0
- data/lib/orb/models/beta_fetch_plan_version_params.rb +20 -0
- data/lib/orb/models/beta_set_default_plan_version_params.rb +22 -0
- data/lib/orb/models/credit_note_create_params.rb +9 -9
- data/lib/orb/models/customer_create_params.rb +21 -3
- data/lib/orb/models/customer_update_by_external_id_params.rb +21 -3
- data/lib/orb/models/customer_update_params.rb +21 -3
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +9 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +9 -1
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +9 -1
- data/lib/orb/models/customers/credits/ledger_list_response.rb +9 -1
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_create_params.rb +1 -1
- data/lib/orb/models/invoice.rb +626 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +624 -9
- data/lib/orb/models/invoice_line_item_create_response.rb +486 -7
- data/lib/orb/models/item.rb +18 -1
- data/lib/orb/models/item_archive_params.rb +14 -0
- data/lib/orb/models/item_create_params.rb +14 -1
- data/lib/orb/models/item_update_params.rb +16 -1
- data/lib/orb/models/percentage_discount.rb +10 -10
- data/lib/orb/models/plan.rb +618 -9
- data/lib/orb/models/plan_create_params.rb +2066 -30
- data/lib/orb/models/plan_version.rb +735 -0
- data/lib/orb/models/plan_version_phase.rb +70 -0
- data/lib/orb/models/price.rb +4124 -70
- data/lib/orb/models/price_create_params.rb +45 -1
- data/lib/orb/models/price_evaluate_multiple_params.rb +8620 -0
- data/lib/orb/models/price_evaluate_multiple_response.rb +51 -0
- data/lib/orb/models/subscription.rb +730 -54
- data/lib/orb/models/subscription_cancel_response.rb +706 -54
- data/lib/orb/models/subscription_change_apply_response.rb +728 -54
- data/lib/orb/models/subscription_change_cancel_response.rb +728 -54
- data/lib/orb/models/subscription_change_retrieve_response.rb +728 -54
- data/lib/orb/models/subscription_create_params.rb +5992 -1698
- data/lib/orb/models/subscription_create_response.rb +706 -54
- data/lib/orb/models/subscription_fetch_schedule_response.rb +3 -3
- data/lib/orb/models/subscription_price_intervals_params.rb +1392 -76
- data/lib/orb/models/subscription_price_intervals_response.rb +712 -54
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +6005 -1723
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +716 -54
- data/lib/orb/models/subscription_trigger_phase_response.rb +708 -54
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +720 -54
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +728 -54
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +728 -54
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +1 -1
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +720 -54
- data/lib/orb/models/subscription_update_trial_response.rb +706 -54
- data/lib/orb/models/trial_discount.rb +10 -10
- data/lib/orb/models/usage_discount.rb +10 -10
- data/lib/orb/models.rb +16 -0
- data/lib/orb/resources/beta/external_plan_id.rb +113 -0
- data/lib/orb/resources/beta.rb +115 -0
- data/lib/orb/resources/credit_notes.rb +3 -3
- data/lib/orb/resources/customers/balance_transactions.rb +0 -7
- data/lib/orb/resources/customers.rb +4 -7
- data/lib/orb/resources/dimensional_price_groups.rb +1 -1
- data/lib/orb/resources/items.rb +34 -2
- data/lib/orb/resources/plans/external_plan_id.rb +1 -1
- data/lib/orb/resources/plans.rb +2 -2
- data/lib/orb/resources/prices.rb +69 -2
- data/lib/orb/resources/subscriptions.rb +5 -1
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +13 -0
- data/rbi/orb/client.rbi +3 -0
- data/rbi/orb/models/alert.rbi +50 -3
- data/rbi/orb/models/amount_discount.rbi +8 -8
- data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +32652 -0
- data/rbi/orb/models/beta/external_plan_id_fetch_plan_version_params.rbi +40 -0
- data/rbi/orb/models/beta/external_plan_id_set_default_plan_version_params.rbi +45 -0
- data/rbi/orb/models/beta_create_plan_version_params.rbi +32595 -0
- data/rbi/orb/models/beta_fetch_plan_version_params.rbi +35 -0
- data/rbi/orb/models/beta_set_default_plan_version_params.rbi +40 -0
- data/rbi/orb/models/credit_note_create_params.rbi +8 -8
- data/rbi/orb/models/customer_create_params.rbi +38 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +38 -4
- data/rbi/orb/models/customer_update_params.rbi +38 -4
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +2 -2
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +2 -2
- data/rbi/orb/models/invoice.rbi +1451 -35
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1524 -4
- data/rbi/orb/models/invoice_line_item_create_response.rbi +1184 -2
- data/rbi/orb/models/item.rbi +20 -1
- data/rbi/orb/models/item_archive_params.rbi +25 -0
- data/rbi/orb/models/item_create_params.rbi +18 -1
- data/rbi/orb/models/item_update_params.rbi +17 -1
- data/rbi/orb/models/percentage_discount.rbi +10 -10
- data/rbi/orb/models/plan.rbi +1339 -4
- data/rbi/orb/models/plan_create_params.rbi +3833 -29
- data/rbi/orb/models/plan_version.rbi +1367 -0
- data/rbi/orb/models/plan_version_phase.rbi +99 -0
- data/rbi/orb/models/price.rbi +9447 -441
- data/rbi/orb/models/price_create_params.rbi +80 -0
- data/rbi/orb/models/price_evaluate_multiple_params.rbi +15764 -0
- data/rbi/orb/models/price_evaluate_multiple_response.rbi +96 -0
- data/rbi/orb/models/subscription.rbi +1654 -44
- data/rbi/orb/models/subscription_cancel_response.rbi +1692 -44
- data/rbi/orb/models/subscription_change_apply_response.rbi +1692 -44
- data/rbi/orb/models/subscription_change_cancel_response.rbi +1692 -44
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +1692 -44
- data/rbi/orb/models/subscription_create_params.rbi +10400 -2710
- data/rbi/orb/models/subscription_create_response.rbi +1692 -44
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +13 -4
- data/rbi/orb/models/subscription_price_intervals_params.rbi +2401 -49
- data/rbi/orb/models/subscription_price_intervals_response.rbi +1692 -44
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +10423 -2753
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +1692 -44
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +1692 -44
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +1692 -44
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1692 -44
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1692 -44
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +2 -2
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1692 -44
- data/rbi/orb/models/subscription_update_trial_response.rbi +1692 -44
- data/rbi/orb/models/trial_discount.rbi +8 -8
- data/rbi/orb/models/usage_discount.rbi +10 -10
- data/rbi/orb/models.rbi +16 -0
- data/rbi/orb/resources/beta/external_plan_id.rbi +118 -0
- data/rbi/orb/resources/beta.rbi +111 -0
- data/rbi/orb/resources/credit_notes.rbi +3 -3
- data/rbi/orb/resources/customers/balance_transactions.rbi +0 -7
- data/rbi/orb/resources/customers/credits/top_ups.rbi +2 -2
- data/rbi/orb/resources/customers.rbi +7 -7
- data/rbi/orb/resources/dimensional_price_groups.rbi +1 -1
- data/rbi/orb/resources/items.rbi +20 -0
- data/rbi/orb/resources/plans/external_plan_id.rbi +1 -1
- data/rbi/orb/resources/plans.rbi +5 -2
- data/rbi/orb/resources/prices.rbi +73 -1
- data/rbi/orb/resources/subscriptions.rbi +9 -1
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/models/alert.rbs +20 -3
- data/sig/orb/models/amount_discount.rbs +5 -5
- data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +12898 -0
- data/sig/orb/models/beta/external_plan_id_fetch_plan_version_params.rbs +25 -0
- data/sig/orb/models/beta/external_plan_id_set_default_plan_version_params.rbs +25 -0
- data/sig/orb/models/beta_create_plan_version_params.rbs +12877 -0
- data/sig/orb/models/beta_fetch_plan_version_params.rbs +20 -0
- data/sig/orb/models/beta_set_default_plan_version_params.rbs +20 -0
- data/sig/orb/models/credit_note_create_params.rbs +6 -6
- data/sig/orb/models/customer_create_params.rbs +13 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +13 -0
- data/sig/orb/models/customer_update_params.rbs +13 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -2
- data/sig/orb/models/invoice.rbs +558 -4
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +558 -4
- data/sig/orb/models/invoice_line_item_create_response.rbs +414 -2
- data/sig/orb/models/item.rbs +5 -0
- data/sig/orb/models/item_archive_params.rbs +14 -0
- data/sig/orb/models/item_create_params.rbs +10 -2
- data/sig/orb/models/item_update_params.rbs +5 -0
- data/sig/orb/models/percentage_discount.rbs +5 -5
- data/sig/orb/models/plan.rbs +538 -4
- data/sig/orb/models/plan_create_params.rbs +1460 -3
- data/sig/orb/models/plan_version.rbs +583 -0
- data/sig/orb/models/plan_version_phase.rbs +60 -0
- data/sig/orb/models/price.rbs +3512 -96
- data/sig/orb/models/price_create_params.rbs +32 -0
- data/sig/orb/models/price_evaluate_multiple_params.rbs +6230 -0
- data/sig/orb/models/price_evaluate_multiple_response.rbs +50 -0
- data/sig/orb/models/subscription.rbs +609 -29
- data/sig/orb/models/subscription_cancel_response.rbs +609 -29
- data/sig/orb/models/subscription_change_apply_response.rbs +621 -29
- data/sig/orb/models/subscription_change_cancel_response.rbs +621 -29
- data/sig/orb/models/subscription_change_retrieve_response.rbs +621 -29
- data/sig/orb/models/subscription_create_params.rbs +4450 -1466
- data/sig/orb/models/subscription_create_response.rbs +609 -29
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +4 -4
- data/sig/orb/models/subscription_price_intervals_params.rbs +920 -24
- data/sig/orb/models/subscription_price_intervals_response.rbs +609 -29
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +4440 -1466
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +609 -29
- data/sig/orb/models/subscription_trigger_phase_response.rbs +609 -29
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +609 -29
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +609 -29
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +609 -29
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +609 -29
- data/sig/orb/models/subscription_update_trial_response.rbs +609 -29
- data/sig/orb/models/trial_discount.rbs +5 -5
- data/sig/orb/models/usage_discount.rbs +5 -5
- data/sig/orb/models.rbs +16 -0
- data/sig/orb/resources/beta/external_plan_id.rbs +34 -0
- data/sig/orb/resources/beta.rbs +34 -0
- data/sig/orb/resources/credit_notes.rbs +1 -1
- data/sig/orb/resources/items.rbs +7 -0
- data/sig/orb/resources/prices.rbs +11 -0
- data/sig/orb/resources/subscriptions.rbs +2 -0
- metadata +40 -1
@@ -99,6 +99,8 @@ module Orb
|
|
99
99
|
required :default_invoice_memo, String, nil?: true
|
100
100
|
|
101
101
|
# @!attribute discount_intervals
|
102
|
+
# @deprecated
|
103
|
+
#
|
102
104
|
# The discount intervals for this subscription sorted by the start_date.
|
103
105
|
#
|
104
106
|
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage>]
|
@@ -123,6 +125,8 @@ module Orb
|
|
123
125
|
required :invoicing_threshold, String, nil?: true
|
124
126
|
|
125
127
|
# @!attribute maximum_intervals
|
128
|
+
# @deprecated
|
129
|
+
#
|
126
130
|
# The maximum intervals for this subscription sorted by the start_date.
|
127
131
|
#
|
128
132
|
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval>]
|
@@ -139,12 +143,20 @@ module Orb
|
|
139
143
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
140
144
|
|
141
145
|
# @!attribute minimum_intervals
|
146
|
+
# @deprecated
|
147
|
+
#
|
142
148
|
# The minimum intervals for this subscription sorted by the start_date.
|
143
149
|
#
|
144
150
|
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval>]
|
145
151
|
required :minimum_intervals,
|
146
152
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval] }
|
147
153
|
|
154
|
+
# @!attribute name
|
155
|
+
# The name of the subscription.
|
156
|
+
#
|
157
|
+
# @return [String]
|
158
|
+
required :name, String
|
159
|
+
|
148
160
|
# @!attribute net_terms
|
149
161
|
# Determines the difference between the invoice issue date for subscription
|
150
162
|
# invoices as the date that they are due. A value of `0` here represents that the
|
@@ -168,8 +180,8 @@ module Orb
|
|
168
180
|
# subscription. You can see more about how to configure prices in the
|
169
181
|
# [Price resource](/reference/price).
|
170
182
|
#
|
171
|
-
# @return [Orb::Models::Plan]
|
172
|
-
required :plan, -> { Orb::Plan }
|
183
|
+
# @return [Orb::Models::Plan, nil]
|
184
|
+
required :plan, -> { Orb::Plan }, nil?: true
|
173
185
|
|
174
186
|
# @!attribute price_intervals
|
175
187
|
# The price intervals for this subscription.
|
@@ -211,7 +223,7 @@ module Orb
|
|
211
223
|
-> { Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources },
|
212
224
|
nil?: true
|
213
225
|
|
214
|
-
# @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil)
|
226
|
+
# @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, name:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil)
|
215
227
|
# Some parameter documentations has been truncated, see
|
216
228
|
# {Orb::Models::SubscriptionTriggerPhaseResponse} for more details.
|
217
229
|
#
|
@@ -251,11 +263,13 @@ module Orb
|
|
251
263
|
#
|
252
264
|
# @param minimum_intervals [Array<Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
|
253
265
|
#
|
266
|
+
# @param name [String] The name of the subscription.
|
267
|
+
#
|
254
268
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
255
269
|
#
|
256
270
|
# @param pending_subscription_change [Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
257
271
|
#
|
258
|
-
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
272
|
+
# @param plan [Orb::Models::Plan, nil] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
259
273
|
#
|
260
274
|
# @param price_intervals [Array<Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval>] The price intervals for this subscription.
|
261
275
|
#
|
@@ -343,11 +357,20 @@ module Orb
|
|
343
357
|
required :adjustment_type, const: :usage_discount
|
344
358
|
|
345
359
|
# @!attribute applies_to_price_ids
|
360
|
+
# @deprecated
|
361
|
+
#
|
346
362
|
# The price IDs that this adjustment applies to.
|
347
363
|
#
|
348
364
|
# @return [Array<String>]
|
349
365
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
350
366
|
|
367
|
+
# @!attribute filters
|
368
|
+
# The filters that determine which prices to apply this adjustment to.
|
369
|
+
#
|
370
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter>]
|
371
|
+
required :filters,
|
372
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter] }
|
373
|
+
|
351
374
|
# @!attribute is_invoice_level
|
352
375
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
353
376
|
# that apply to only one price.
|
@@ -374,7 +397,7 @@ module Orb
|
|
374
397
|
# @return [Float]
|
375
398
|
required :usage_discount, Float
|
376
399
|
|
377
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
400
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
378
401
|
# Some parameter documentations has been truncated, see
|
379
402
|
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
380
403
|
# for more details.
|
@@ -383,6 +406,8 @@ module Orb
|
|
383
406
|
#
|
384
407
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
385
408
|
#
|
409
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
410
|
+
#
|
386
411
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
387
412
|
#
|
388
413
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
@@ -392,6 +417,64 @@ module Orb
|
|
392
417
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
393
418
|
#
|
394
419
|
# @param adjustment_type [Symbol, :usage_discount]
|
420
|
+
|
421
|
+
class Filter < Orb::Internal::Type::BaseModel
|
422
|
+
# @!attribute field
|
423
|
+
# The property of the price to filter on.
|
424
|
+
#
|
425
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field]
|
426
|
+
required :field,
|
427
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field }
|
428
|
+
|
429
|
+
# @!attribute operator
|
430
|
+
# Should prices that match the filter be included or excluded.
|
431
|
+
#
|
432
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator]
|
433
|
+
required :operator,
|
434
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator }
|
435
|
+
|
436
|
+
# @!attribute values
|
437
|
+
# The IDs or values that match this filter.
|
438
|
+
#
|
439
|
+
# @return [Array<String>]
|
440
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
441
|
+
|
442
|
+
# @!method initialize(field:, operator:, values:)
|
443
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field] The property of the price to filter on.
|
444
|
+
#
|
445
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
446
|
+
#
|
447
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
448
|
+
|
449
|
+
# The property of the price to filter on.
|
450
|
+
#
|
451
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter#field
|
452
|
+
module Field
|
453
|
+
extend Orb::Internal::Type::Enum
|
454
|
+
|
455
|
+
PRICE_ID = :price_id
|
456
|
+
ITEM_ID = :item_id
|
457
|
+
PRICE_TYPE = :price_type
|
458
|
+
CURRENCY = :currency
|
459
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
460
|
+
|
461
|
+
# @!method self.values
|
462
|
+
# @return [Array<Symbol>]
|
463
|
+
end
|
464
|
+
|
465
|
+
# Should prices that match the filter be included or excluded.
|
466
|
+
#
|
467
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter#operator
|
468
|
+
module Operator
|
469
|
+
extend Orb::Internal::Type::Enum
|
470
|
+
|
471
|
+
INCLUDES = :includes
|
472
|
+
EXCLUDES = :excludes
|
473
|
+
|
474
|
+
# @!method self.values
|
475
|
+
# @return [Array<Symbol>]
|
476
|
+
end
|
477
|
+
end
|
395
478
|
end
|
396
479
|
|
397
480
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
@@ -413,11 +496,20 @@ module Orb
|
|
413
496
|
required :amount_discount, String
|
414
497
|
|
415
498
|
# @!attribute applies_to_price_ids
|
499
|
+
# @deprecated
|
500
|
+
#
|
416
501
|
# The price IDs that this adjustment applies to.
|
417
502
|
#
|
418
503
|
# @return [Array<String>]
|
419
504
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
420
505
|
|
506
|
+
# @!attribute filters
|
507
|
+
# The filters that determine which prices to apply this adjustment to.
|
508
|
+
#
|
509
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter>]
|
510
|
+
required :filters,
|
511
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter] }
|
512
|
+
|
421
513
|
# @!attribute is_invoice_level
|
422
514
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
423
515
|
# that apply to only one price.
|
@@ -437,7 +529,7 @@ module Orb
|
|
437
529
|
# @return [String, nil]
|
438
530
|
required :reason, String, nil?: true
|
439
531
|
|
440
|
-
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
532
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
441
533
|
# Some parameter documentations has been truncated, see
|
442
534
|
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
443
535
|
# for more details.
|
@@ -448,6 +540,8 @@ module Orb
|
|
448
540
|
#
|
449
541
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
450
542
|
#
|
543
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
544
|
+
#
|
451
545
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
452
546
|
#
|
453
547
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
@@ -455,6 +549,64 @@ module Orb
|
|
455
549
|
# @param reason [String, nil] The reason for the adjustment.
|
456
550
|
#
|
457
551
|
# @param adjustment_type [Symbol, :amount_discount]
|
552
|
+
|
553
|
+
class Filter < Orb::Internal::Type::BaseModel
|
554
|
+
# @!attribute field
|
555
|
+
# The property of the price to filter on.
|
556
|
+
#
|
557
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field]
|
558
|
+
required :field,
|
559
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field }
|
560
|
+
|
561
|
+
# @!attribute operator
|
562
|
+
# Should prices that match the filter be included or excluded.
|
563
|
+
#
|
564
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator]
|
565
|
+
required :operator,
|
566
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator }
|
567
|
+
|
568
|
+
# @!attribute values
|
569
|
+
# The IDs or values that match this filter.
|
570
|
+
#
|
571
|
+
# @return [Array<String>]
|
572
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
573
|
+
|
574
|
+
# @!method initialize(field:, operator:, values:)
|
575
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field] The property of the price to filter on.
|
576
|
+
#
|
577
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
578
|
+
#
|
579
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
580
|
+
|
581
|
+
# The property of the price to filter on.
|
582
|
+
#
|
583
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter#field
|
584
|
+
module Field
|
585
|
+
extend Orb::Internal::Type::Enum
|
586
|
+
|
587
|
+
PRICE_ID = :price_id
|
588
|
+
ITEM_ID = :item_id
|
589
|
+
PRICE_TYPE = :price_type
|
590
|
+
CURRENCY = :currency
|
591
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
592
|
+
|
593
|
+
# @!method self.values
|
594
|
+
# @return [Array<Symbol>]
|
595
|
+
end
|
596
|
+
|
597
|
+
# Should prices that match the filter be included or excluded.
|
598
|
+
#
|
599
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter#operator
|
600
|
+
module Operator
|
601
|
+
extend Orb::Internal::Type::Enum
|
602
|
+
|
603
|
+
INCLUDES = :includes
|
604
|
+
EXCLUDES = :excludes
|
605
|
+
|
606
|
+
# @!method self.values
|
607
|
+
# @return [Array<Symbol>]
|
608
|
+
end
|
609
|
+
end
|
458
610
|
end
|
459
611
|
|
460
612
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
@@ -469,11 +621,20 @@ module Orb
|
|
469
621
|
required :adjustment_type, const: :percentage_discount
|
470
622
|
|
471
623
|
# @!attribute applies_to_price_ids
|
624
|
+
# @deprecated
|
625
|
+
#
|
472
626
|
# The price IDs that this adjustment applies to.
|
473
627
|
#
|
474
628
|
# @return [Array<String>]
|
475
629
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
476
630
|
|
631
|
+
# @!attribute filters
|
632
|
+
# The filters that determine which prices to apply this adjustment to.
|
633
|
+
#
|
634
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter>]
|
635
|
+
required :filters,
|
636
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter] }
|
637
|
+
|
477
638
|
# @!attribute is_invoice_level
|
478
639
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
479
640
|
# that apply to only one price.
|
@@ -500,7 +661,7 @@ module Orb
|
|
500
661
|
# @return [String, nil]
|
501
662
|
required :reason, String, nil?: true
|
502
663
|
|
503
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
664
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
504
665
|
# Some parameter documentations has been truncated, see
|
505
666
|
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
506
667
|
# for more details.
|
@@ -509,6 +670,8 @@ module Orb
|
|
509
670
|
#
|
510
671
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
511
672
|
#
|
673
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
|
674
|
+
#
|
512
675
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
513
676
|
#
|
514
677
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
@@ -518,6 +681,64 @@ module Orb
|
|
518
681
|
# @param reason [String, nil] The reason for the adjustment.
|
519
682
|
#
|
520
683
|
# @param adjustment_type [Symbol, :percentage_discount]
|
684
|
+
|
685
|
+
class Filter < Orb::Internal::Type::BaseModel
|
686
|
+
# @!attribute field
|
687
|
+
# The property of the price to filter on.
|
688
|
+
#
|
689
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field]
|
690
|
+
required :field,
|
691
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field }
|
692
|
+
|
693
|
+
# @!attribute operator
|
694
|
+
# Should prices that match the filter be included or excluded.
|
695
|
+
#
|
696
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator]
|
697
|
+
required :operator,
|
698
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator }
|
699
|
+
|
700
|
+
# @!attribute values
|
701
|
+
# The IDs or values that match this filter.
|
702
|
+
#
|
703
|
+
# @return [Array<String>]
|
704
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
705
|
+
|
706
|
+
# @!method initialize(field:, operator:, values:)
|
707
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field] The property of the price to filter on.
|
708
|
+
#
|
709
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
|
710
|
+
#
|
711
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
712
|
+
|
713
|
+
# The property of the price to filter on.
|
714
|
+
#
|
715
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter#field
|
716
|
+
module Field
|
717
|
+
extend Orb::Internal::Type::Enum
|
718
|
+
|
719
|
+
PRICE_ID = :price_id
|
720
|
+
ITEM_ID = :item_id
|
721
|
+
PRICE_TYPE = :price_type
|
722
|
+
CURRENCY = :currency
|
723
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
724
|
+
|
725
|
+
# @!method self.values
|
726
|
+
# @return [Array<Symbol>]
|
727
|
+
end
|
728
|
+
|
729
|
+
# Should prices that match the filter be included or excluded.
|
730
|
+
#
|
731
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter#operator
|
732
|
+
module Operator
|
733
|
+
extend Orb::Internal::Type::Enum
|
734
|
+
|
735
|
+
INCLUDES = :includes
|
736
|
+
EXCLUDES = :excludes
|
737
|
+
|
738
|
+
# @!method self.values
|
739
|
+
# @return [Array<Symbol>]
|
740
|
+
end
|
741
|
+
end
|
521
742
|
end
|
522
743
|
|
523
744
|
class Minimum < Orb::Internal::Type::BaseModel
|
@@ -532,11 +753,20 @@ module Orb
|
|
532
753
|
required :adjustment_type, const: :minimum
|
533
754
|
|
534
755
|
# @!attribute applies_to_price_ids
|
756
|
+
# @deprecated
|
757
|
+
#
|
535
758
|
# The price IDs that this adjustment applies to.
|
536
759
|
#
|
537
760
|
# @return [Array<String>]
|
538
761
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
539
762
|
|
763
|
+
# @!attribute filters
|
764
|
+
# The filters that determine which prices to apply this adjustment to.
|
765
|
+
#
|
766
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter>]
|
767
|
+
required :filters,
|
768
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter] }
|
769
|
+
|
540
770
|
# @!attribute is_invoice_level
|
541
771
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
542
772
|
# that apply to only one price.
|
@@ -569,7 +799,7 @@ module Orb
|
|
569
799
|
# @return [String, nil]
|
570
800
|
required :reason, String, nil?: true
|
571
801
|
|
572
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
802
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
573
803
|
# Some parameter documentations has been truncated, see
|
574
804
|
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum}
|
575
805
|
# for more details.
|
@@ -578,6 +808,8 @@ module Orb
|
|
578
808
|
#
|
579
809
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
580
810
|
#
|
811
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter>] The filters that determine which prices to apply this adjustment to.
|
812
|
+
#
|
581
813
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
582
814
|
#
|
583
815
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
@@ -589,6 +821,64 @@ module Orb
|
|
589
821
|
# @param reason [String, nil] The reason for the adjustment.
|
590
822
|
#
|
591
823
|
# @param adjustment_type [Symbol, :minimum]
|
824
|
+
|
825
|
+
class Filter < Orb::Internal::Type::BaseModel
|
826
|
+
# @!attribute field
|
827
|
+
# The property of the price to filter on.
|
828
|
+
#
|
829
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field]
|
830
|
+
required :field,
|
831
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field }
|
832
|
+
|
833
|
+
# @!attribute operator
|
834
|
+
# Should prices that match the filter be included or excluded.
|
835
|
+
#
|
836
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator]
|
837
|
+
required :operator,
|
838
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator }
|
839
|
+
|
840
|
+
# @!attribute values
|
841
|
+
# The IDs or values that match this filter.
|
842
|
+
#
|
843
|
+
# @return [Array<String>]
|
844
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
845
|
+
|
846
|
+
# @!method initialize(field:, operator:, values:)
|
847
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field] The property of the price to filter on.
|
848
|
+
#
|
849
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
|
850
|
+
#
|
851
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
852
|
+
|
853
|
+
# The property of the price to filter on.
|
854
|
+
#
|
855
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter#field
|
856
|
+
module Field
|
857
|
+
extend Orb::Internal::Type::Enum
|
858
|
+
|
859
|
+
PRICE_ID = :price_id
|
860
|
+
ITEM_ID = :item_id
|
861
|
+
PRICE_TYPE = :price_type
|
862
|
+
CURRENCY = :currency
|
863
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
864
|
+
|
865
|
+
# @!method self.values
|
866
|
+
# @return [Array<Symbol>]
|
867
|
+
end
|
868
|
+
|
869
|
+
# Should prices that match the filter be included or excluded.
|
870
|
+
#
|
871
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::Filter#operator
|
872
|
+
module Operator
|
873
|
+
extend Orb::Internal::Type::Enum
|
874
|
+
|
875
|
+
INCLUDES = :includes
|
876
|
+
EXCLUDES = :excludes
|
877
|
+
|
878
|
+
# @!method self.values
|
879
|
+
# @return [Array<Symbol>]
|
880
|
+
end
|
881
|
+
end
|
592
882
|
end
|
593
883
|
|
594
884
|
class Maximum < Orb::Internal::Type::BaseModel
|
@@ -603,11 +893,20 @@ module Orb
|
|
603
893
|
required :adjustment_type, const: :maximum
|
604
894
|
|
605
895
|
# @!attribute applies_to_price_ids
|
896
|
+
# @deprecated
|
897
|
+
#
|
606
898
|
# The price IDs that this adjustment applies to.
|
607
899
|
#
|
608
900
|
# @return [Array<String>]
|
609
901
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
610
902
|
|
903
|
+
# @!attribute filters
|
904
|
+
# The filters that determine which prices to apply this adjustment to.
|
905
|
+
#
|
906
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter>]
|
907
|
+
required :filters,
|
908
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter] }
|
909
|
+
|
611
910
|
# @!attribute is_invoice_level
|
612
911
|
# True for adjustments that apply to an entire invocice, false for adjustments
|
613
912
|
# that apply to only one price.
|
@@ -634,7 +933,7 @@ module Orb
|
|
634
933
|
# @return [String, nil]
|
635
934
|
required :reason, String, nil?: true
|
636
935
|
|
637
|
-
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
936
|
+
# @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
638
937
|
# Some parameter documentations has been truncated, see
|
639
938
|
# {Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum}
|
640
939
|
# for more details.
|
@@ -643,6 +942,8 @@ module Orb
|
|
643
942
|
#
|
644
943
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
645
944
|
#
|
945
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter>] The filters that determine which prices to apply this adjustment to.
|
946
|
+
#
|
646
947
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
647
948
|
#
|
648
949
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
@@ -652,6 +953,64 @@ module Orb
|
|
652
953
|
# @param reason [String, nil] The reason for the adjustment.
|
653
954
|
#
|
654
955
|
# @param adjustment_type [Symbol, :maximum]
|
956
|
+
|
957
|
+
class Filter < Orb::Internal::Type::BaseModel
|
958
|
+
# @!attribute field
|
959
|
+
# The property of the price to filter on.
|
960
|
+
#
|
961
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field]
|
962
|
+
required :field,
|
963
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field }
|
964
|
+
|
965
|
+
# @!attribute operator
|
966
|
+
# Should prices that match the filter be included or excluded.
|
967
|
+
#
|
968
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator]
|
969
|
+
required :operator,
|
970
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator }
|
971
|
+
|
972
|
+
# @!attribute values
|
973
|
+
# The IDs or values that match this filter.
|
974
|
+
#
|
975
|
+
# @return [Array<String>]
|
976
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
977
|
+
|
978
|
+
# @!method initialize(field:, operator:, values:)
|
979
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field] The property of the price to filter on.
|
980
|
+
#
|
981
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
|
982
|
+
#
|
983
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
984
|
+
|
985
|
+
# The property of the price to filter on.
|
986
|
+
#
|
987
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter#field
|
988
|
+
module Field
|
989
|
+
extend Orb::Internal::Type::Enum
|
990
|
+
|
991
|
+
PRICE_ID = :price_id
|
992
|
+
ITEM_ID = :item_id
|
993
|
+
PRICE_TYPE = :price_type
|
994
|
+
CURRENCY = :currency
|
995
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
996
|
+
|
997
|
+
# @!method self.values
|
998
|
+
# @return [Array<Symbol>]
|
999
|
+
end
|
1000
|
+
|
1001
|
+
# Should prices that match the filter be included or excluded.
|
1002
|
+
#
|
1003
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::Filter#operator
|
1004
|
+
module Operator
|
1005
|
+
extend Orb::Internal::Type::Enum
|
1006
|
+
|
1007
|
+
INCLUDES = :includes
|
1008
|
+
EXCLUDES = :excludes
|
1009
|
+
|
1010
|
+
# @!method self.values
|
1011
|
+
# @return [Array<Symbol>]
|
1012
|
+
end
|
1013
|
+
end
|
655
1014
|
end
|
656
1015
|
|
657
1016
|
# @!method self.variants
|
@@ -715,12 +1074,6 @@ module Orb
|
|
715
1074
|
# @return [String]
|
716
1075
|
required :amount_discount, String
|
717
1076
|
|
718
|
-
# @!attribute applies_to_price_ids
|
719
|
-
# The price ids that this discount interval applies to.
|
720
|
-
#
|
721
|
-
# @return [Array<String>]
|
722
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
723
|
-
|
724
1077
|
# @!attribute applies_to_price_interval_ids
|
725
1078
|
# The price interval ids that this discount interval applies to.
|
726
1079
|
#
|
@@ -738,33 +1091,92 @@ module Orb
|
|
738
1091
|
# @return [Time, nil]
|
739
1092
|
required :end_date, Time, nil?: true
|
740
1093
|
|
1094
|
+
# @!attribute filters
|
1095
|
+
# The filters that determine which prices this discount interval applies to.
|
1096
|
+
#
|
1097
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter>]
|
1098
|
+
required :filters,
|
1099
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter] }
|
1100
|
+
|
741
1101
|
# @!attribute start_date
|
742
1102
|
# The start date of the discount interval.
|
743
1103
|
#
|
744
1104
|
# @return [Time]
|
745
1105
|
required :start_date, Time
|
746
1106
|
|
747
|
-
# @!method initialize(amount_discount:,
|
1107
|
+
# @!method initialize(amount_discount:, applies_to_price_interval_ids:, end_date:, filters:, start_date:, discount_type: :amount)
|
748
1108
|
# @param amount_discount [String] Only available if discount_type is `amount`.
|
749
1109
|
#
|
750
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
751
|
-
#
|
752
1110
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
753
1111
|
#
|
754
1112
|
# @param end_date [Time, nil] The end date of the discount interval.
|
755
1113
|
#
|
1114
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter>] The filters that determine which prices this discount interval applies to.
|
1115
|
+
#
|
756
1116
|
# @param start_date [Time] The start date of the discount interval.
|
757
1117
|
#
|
758
1118
|
# @param discount_type [Symbol, :amount]
|
1119
|
+
|
1120
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1121
|
+
# @!attribute field
|
1122
|
+
# The property of the price to filter on.
|
1123
|
+
#
|
1124
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter::Field]
|
1125
|
+
required :field,
|
1126
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter::Field }
|
1127
|
+
|
1128
|
+
# @!attribute operator
|
1129
|
+
# Should prices that match the filter be included or excluded.
|
1130
|
+
#
|
1131
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter::Operator]
|
1132
|
+
required :operator,
|
1133
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter::Operator }
|
1134
|
+
|
1135
|
+
# @!attribute values
|
1136
|
+
# The IDs or values that match this filter.
|
1137
|
+
#
|
1138
|
+
# @return [Array<String>]
|
1139
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1140
|
+
|
1141
|
+
# @!method initialize(field:, operator:, values:)
|
1142
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter::Field] The property of the price to filter on.
|
1143
|
+
#
|
1144
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter::Operator] Should prices that match the filter be included or excluded.
|
1145
|
+
#
|
1146
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1147
|
+
|
1148
|
+
# The property of the price to filter on.
|
1149
|
+
#
|
1150
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter#field
|
1151
|
+
module Field
|
1152
|
+
extend Orb::Internal::Type::Enum
|
1153
|
+
|
1154
|
+
PRICE_ID = :price_id
|
1155
|
+
ITEM_ID = :item_id
|
1156
|
+
PRICE_TYPE = :price_type
|
1157
|
+
CURRENCY = :currency
|
1158
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1159
|
+
|
1160
|
+
# @!method self.values
|
1161
|
+
# @return [Array<Symbol>]
|
1162
|
+
end
|
1163
|
+
|
1164
|
+
# Should prices that match the filter be included or excluded.
|
1165
|
+
#
|
1166
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::Filter#operator
|
1167
|
+
module Operator
|
1168
|
+
extend Orb::Internal::Type::Enum
|
1169
|
+
|
1170
|
+
INCLUDES = :includes
|
1171
|
+
EXCLUDES = :excludes
|
1172
|
+
|
1173
|
+
# @!method self.values
|
1174
|
+
# @return [Array<Symbol>]
|
1175
|
+
end
|
1176
|
+
end
|
759
1177
|
end
|
760
1178
|
|
761
1179
|
class Percentage < Orb::Internal::Type::BaseModel
|
762
|
-
# @!attribute applies_to_price_ids
|
763
|
-
# The price ids that this discount interval applies to.
|
764
|
-
#
|
765
|
-
# @return [Array<String>]
|
766
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
767
|
-
|
768
1180
|
# @!attribute applies_to_price_interval_ids
|
769
1181
|
# The price interval ids that this discount interval applies to.
|
770
1182
|
#
|
@@ -782,6 +1194,13 @@ module Orb
|
|
782
1194
|
# @return [Time, nil]
|
783
1195
|
required :end_date, Time, nil?: true
|
784
1196
|
|
1197
|
+
# @!attribute filters
|
1198
|
+
# The filters that determine which prices this discount interval applies to.
|
1199
|
+
#
|
1200
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter>]
|
1201
|
+
required :filters,
|
1202
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter] }
|
1203
|
+
|
785
1204
|
# @!attribute percentage_discount
|
786
1205
|
# Only available if discount_type is `percentage`.This is a number between 0
|
787
1206
|
# and 1.
|
@@ -795,31 +1214,83 @@ module Orb
|
|
795
1214
|
# @return [Time]
|
796
1215
|
required :start_date, Time
|
797
1216
|
|
798
|
-
# @!method initialize(
|
1217
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, percentage_discount:, start_date:, discount_type: :percentage)
|
799
1218
|
# Some parameter documentations has been truncated, see
|
800
1219
|
# {Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage}
|
801
1220
|
# for more details.
|
802
1221
|
#
|
803
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
804
|
-
#
|
805
1222
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
806
1223
|
#
|
807
1224
|
# @param end_date [Time, nil] The end date of the discount interval.
|
808
1225
|
#
|
1226
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter>] The filters that determine which prices this discount interval applies to.
|
1227
|
+
#
|
809
1228
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
|
810
1229
|
#
|
811
1230
|
# @param start_date [Time] The start date of the discount interval.
|
812
1231
|
#
|
813
1232
|
# @param discount_type [Symbol, :percentage]
|
1233
|
+
|
1234
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1235
|
+
# @!attribute field
|
1236
|
+
# The property of the price to filter on.
|
1237
|
+
#
|
1238
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter::Field]
|
1239
|
+
required :field,
|
1240
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter::Field }
|
1241
|
+
|
1242
|
+
# @!attribute operator
|
1243
|
+
# Should prices that match the filter be included or excluded.
|
1244
|
+
#
|
1245
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter::Operator]
|
1246
|
+
required :operator,
|
1247
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter::Operator }
|
1248
|
+
|
1249
|
+
# @!attribute values
|
1250
|
+
# The IDs or values that match this filter.
|
1251
|
+
#
|
1252
|
+
# @return [Array<String>]
|
1253
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1254
|
+
|
1255
|
+
# @!method initialize(field:, operator:, values:)
|
1256
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter::Field] The property of the price to filter on.
|
1257
|
+
#
|
1258
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter::Operator] Should prices that match the filter be included or excluded.
|
1259
|
+
#
|
1260
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1261
|
+
|
1262
|
+
# The property of the price to filter on.
|
1263
|
+
#
|
1264
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter#field
|
1265
|
+
module Field
|
1266
|
+
extend Orb::Internal::Type::Enum
|
1267
|
+
|
1268
|
+
PRICE_ID = :price_id
|
1269
|
+
ITEM_ID = :item_id
|
1270
|
+
PRICE_TYPE = :price_type
|
1271
|
+
CURRENCY = :currency
|
1272
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1273
|
+
|
1274
|
+
# @!method self.values
|
1275
|
+
# @return [Array<Symbol>]
|
1276
|
+
end
|
1277
|
+
|
1278
|
+
# Should prices that match the filter be included or excluded.
|
1279
|
+
#
|
1280
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::Filter#operator
|
1281
|
+
module Operator
|
1282
|
+
extend Orb::Internal::Type::Enum
|
1283
|
+
|
1284
|
+
INCLUDES = :includes
|
1285
|
+
EXCLUDES = :excludes
|
1286
|
+
|
1287
|
+
# @!method self.values
|
1288
|
+
# @return [Array<Symbol>]
|
1289
|
+
end
|
1290
|
+
end
|
814
1291
|
end
|
815
1292
|
|
816
1293
|
class Usage < Orb::Internal::Type::BaseModel
|
817
|
-
# @!attribute applies_to_price_ids
|
818
|
-
# The price ids that this discount interval applies to.
|
819
|
-
#
|
820
|
-
# @return [Array<String>]
|
821
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
822
|
-
|
823
1294
|
# @!attribute applies_to_price_interval_ids
|
824
1295
|
# The price interval ids that this discount interval applies to.
|
825
1296
|
#
|
@@ -837,6 +1308,13 @@ module Orb
|
|
837
1308
|
# @return [Time, nil]
|
838
1309
|
required :end_date, Time, nil?: true
|
839
1310
|
|
1311
|
+
# @!attribute filters
|
1312
|
+
# The filters that determine which prices this discount interval applies to.
|
1313
|
+
#
|
1314
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter>]
|
1315
|
+
required :filters,
|
1316
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter] }
|
1317
|
+
|
840
1318
|
# @!attribute start_date
|
841
1319
|
# The start date of the discount interval.
|
842
1320
|
#
|
@@ -850,22 +1328,80 @@ module Orb
|
|
850
1328
|
# @return [Float]
|
851
1329
|
required :usage_discount, Float
|
852
1330
|
|
853
|
-
# @!method initialize(
|
1331
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, start_date:, usage_discount:, discount_type: :usage)
|
854
1332
|
# Some parameter documentations has been truncated, see
|
855
1333
|
# {Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage} for
|
856
1334
|
# more details.
|
857
1335
|
#
|
858
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
859
|
-
#
|
860
1336
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
|
861
1337
|
#
|
862
1338
|
# @param end_date [Time, nil] The end date of the discount interval.
|
863
1339
|
#
|
1340
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter>] The filters that determine which prices this discount interval applies to.
|
1341
|
+
#
|
864
1342
|
# @param start_date [Time] The start date of the discount interval.
|
865
1343
|
#
|
866
1344
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
867
1345
|
#
|
868
1346
|
# @param discount_type [Symbol, :usage]
|
1347
|
+
|
1348
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1349
|
+
# @!attribute field
|
1350
|
+
# The property of the price to filter on.
|
1351
|
+
#
|
1352
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter::Field]
|
1353
|
+
required :field,
|
1354
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter::Field }
|
1355
|
+
|
1356
|
+
# @!attribute operator
|
1357
|
+
# Should prices that match the filter be included or excluded.
|
1358
|
+
#
|
1359
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter::Operator]
|
1360
|
+
required :operator,
|
1361
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter::Operator }
|
1362
|
+
|
1363
|
+
# @!attribute values
|
1364
|
+
# The IDs or values that match this filter.
|
1365
|
+
#
|
1366
|
+
# @return [Array<String>]
|
1367
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1368
|
+
|
1369
|
+
# @!method initialize(field:, operator:, values:)
|
1370
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter::Field] The property of the price to filter on.
|
1371
|
+
#
|
1372
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter::Operator] Should prices that match the filter be included or excluded.
|
1373
|
+
#
|
1374
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1375
|
+
|
1376
|
+
# The property of the price to filter on.
|
1377
|
+
#
|
1378
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter#field
|
1379
|
+
module Field
|
1380
|
+
extend Orb::Internal::Type::Enum
|
1381
|
+
|
1382
|
+
PRICE_ID = :price_id
|
1383
|
+
ITEM_ID = :item_id
|
1384
|
+
PRICE_TYPE = :price_type
|
1385
|
+
CURRENCY = :currency
|
1386
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1387
|
+
|
1388
|
+
# @!method self.values
|
1389
|
+
# @return [Array<Symbol>]
|
1390
|
+
end
|
1391
|
+
|
1392
|
+
# Should prices that match the filter be included or excluded.
|
1393
|
+
#
|
1394
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::Filter#operator
|
1395
|
+
module Operator
|
1396
|
+
extend Orb::Internal::Type::Enum
|
1397
|
+
|
1398
|
+
INCLUDES = :includes
|
1399
|
+
EXCLUDES = :excludes
|
1400
|
+
|
1401
|
+
# @!method self.values
|
1402
|
+
# @return [Array<Symbol>]
|
1403
|
+
end
|
1404
|
+
end
|
869
1405
|
end
|
870
1406
|
|
871
1407
|
# @!method self.variants
|
@@ -901,12 +1437,6 @@ module Orb
|
|
901
1437
|
end
|
902
1438
|
|
903
1439
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
904
|
-
# @!attribute applies_to_price_ids
|
905
|
-
# The price ids that this maximum interval applies to.
|
906
|
-
#
|
907
|
-
# @return [Array<String>]
|
908
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
909
|
-
|
910
1440
|
# @!attribute applies_to_price_interval_ids
|
911
1441
|
# The price interval ids that this maximum interval applies to.
|
912
1442
|
#
|
@@ -919,6 +1449,13 @@ module Orb
|
|
919
1449
|
# @return [Time, nil]
|
920
1450
|
required :end_date, Time, nil?: true
|
921
1451
|
|
1452
|
+
# @!attribute filters
|
1453
|
+
# The filters that determine which prices this maximum interval applies to.
|
1454
|
+
#
|
1455
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter>]
|
1456
|
+
required :filters,
|
1457
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter] }
|
1458
|
+
|
922
1459
|
# @!attribute maximum_amount
|
923
1460
|
# The maximum amount to charge in a given billing period for the price intervals
|
924
1461
|
# this transform applies to.
|
@@ -932,29 +1469,81 @@ module Orb
|
|
932
1469
|
# @return [Time]
|
933
1470
|
required :start_date, Time
|
934
1471
|
|
935
|
-
# @!method initialize(
|
1472
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, maximum_amount:, start_date:)
|
936
1473
|
# Some parameter documentations has been truncated, see
|
937
1474
|
# {Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval} for more
|
938
1475
|
# details.
|
939
1476
|
#
|
940
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
|
941
|
-
#
|
942
1477
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
|
943
1478
|
#
|
944
1479
|
# @param end_date [Time, nil] The end date of the maximum interval.
|
945
1480
|
#
|
1481
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter>] The filters that determine which prices this maximum interval applies to.
|
1482
|
+
#
|
946
1483
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
|
947
1484
|
#
|
948
1485
|
# @param start_date [Time] The start date of the maximum interval.
|
1486
|
+
|
1487
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1488
|
+
# @!attribute field
|
1489
|
+
# The property of the price to filter on.
|
1490
|
+
#
|
1491
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter::Field]
|
1492
|
+
required :field,
|
1493
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter::Field }
|
1494
|
+
|
1495
|
+
# @!attribute operator
|
1496
|
+
# Should prices that match the filter be included or excluded.
|
1497
|
+
#
|
1498
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter::Operator]
|
1499
|
+
required :operator,
|
1500
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter::Operator }
|
1501
|
+
|
1502
|
+
# @!attribute values
|
1503
|
+
# The IDs or values that match this filter.
|
1504
|
+
#
|
1505
|
+
# @return [Array<String>]
|
1506
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1507
|
+
|
1508
|
+
# @!method initialize(field:, operator:, values:)
|
1509
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter::Field] The property of the price to filter on.
|
1510
|
+
#
|
1511
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
|
1512
|
+
#
|
1513
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1514
|
+
|
1515
|
+
# The property of the price to filter on.
|
1516
|
+
#
|
1517
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter#field
|
1518
|
+
module Field
|
1519
|
+
extend Orb::Internal::Type::Enum
|
1520
|
+
|
1521
|
+
PRICE_ID = :price_id
|
1522
|
+
ITEM_ID = :item_id
|
1523
|
+
PRICE_TYPE = :price_type
|
1524
|
+
CURRENCY = :currency
|
1525
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1526
|
+
|
1527
|
+
# @!method self.values
|
1528
|
+
# @return [Array<Symbol>]
|
1529
|
+
end
|
1530
|
+
|
1531
|
+
# Should prices that match the filter be included or excluded.
|
1532
|
+
#
|
1533
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::Filter#operator
|
1534
|
+
module Operator
|
1535
|
+
extend Orb::Internal::Type::Enum
|
1536
|
+
|
1537
|
+
INCLUDES = :includes
|
1538
|
+
EXCLUDES = :excludes
|
1539
|
+
|
1540
|
+
# @!method self.values
|
1541
|
+
# @return [Array<Symbol>]
|
1542
|
+
end
|
1543
|
+
end
|
949
1544
|
end
|
950
1545
|
|
951
1546
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
952
|
-
# @!attribute applies_to_price_ids
|
953
|
-
# The price ids that this minimum interval applies to.
|
954
|
-
#
|
955
|
-
# @return [Array<String>]
|
956
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
957
|
-
|
958
1547
|
# @!attribute applies_to_price_interval_ids
|
959
1548
|
# The price interval ids that this minimum interval applies to.
|
960
1549
|
#
|
@@ -967,6 +1556,13 @@ module Orb
|
|
967
1556
|
# @return [Time, nil]
|
968
1557
|
required :end_date, Time, nil?: true
|
969
1558
|
|
1559
|
+
# @!attribute filters
|
1560
|
+
# The filters that determine which prices this minimum interval applies to.
|
1561
|
+
#
|
1562
|
+
# @return [Array<Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter>]
|
1563
|
+
required :filters,
|
1564
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter] }
|
1565
|
+
|
970
1566
|
# @!attribute minimum_amount
|
971
1567
|
# The minimum amount to charge in a given billing period for the price intervals
|
972
1568
|
# this minimum applies to.
|
@@ -980,20 +1576,78 @@ module Orb
|
|
980
1576
|
# @return [Time]
|
981
1577
|
required :start_date, Time
|
982
1578
|
|
983
|
-
# @!method initialize(
|
1579
|
+
# @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, minimum_amount:, start_date:)
|
984
1580
|
# Some parameter documentations has been truncated, see
|
985
1581
|
# {Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval} for more
|
986
1582
|
# details.
|
987
1583
|
#
|
988
|
-
# @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
|
989
|
-
#
|
990
1584
|
# @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
|
991
1585
|
#
|
992
1586
|
# @param end_date [Time, nil] The end date of the minimum interval.
|
993
1587
|
#
|
1588
|
+
# @param filters [Array<Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter>] The filters that determine which prices this minimum interval applies to.
|
1589
|
+
#
|
994
1590
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
|
995
1591
|
#
|
996
1592
|
# @param start_date [Time] The start date of the minimum interval.
|
1593
|
+
|
1594
|
+
class Filter < Orb::Internal::Type::BaseModel
|
1595
|
+
# @!attribute field
|
1596
|
+
# The property of the price to filter on.
|
1597
|
+
#
|
1598
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter::Field]
|
1599
|
+
required :field,
|
1600
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter::Field }
|
1601
|
+
|
1602
|
+
# @!attribute operator
|
1603
|
+
# Should prices that match the filter be included or excluded.
|
1604
|
+
#
|
1605
|
+
# @return [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter::Operator]
|
1606
|
+
required :operator,
|
1607
|
+
enum: -> { Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter::Operator }
|
1608
|
+
|
1609
|
+
# @!attribute values
|
1610
|
+
# The IDs or values that match this filter.
|
1611
|
+
#
|
1612
|
+
# @return [Array<String>]
|
1613
|
+
required :values, Orb::Internal::Type::ArrayOf[String]
|
1614
|
+
|
1615
|
+
# @!method initialize(field:, operator:, values:)
|
1616
|
+
# @param field [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter::Field] The property of the price to filter on.
|
1617
|
+
#
|
1618
|
+
# @param operator [Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
|
1619
|
+
#
|
1620
|
+
# @param values [Array<String>] The IDs or values that match this filter.
|
1621
|
+
|
1622
|
+
# The property of the price to filter on.
|
1623
|
+
#
|
1624
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter#field
|
1625
|
+
module Field
|
1626
|
+
extend Orb::Internal::Type::Enum
|
1627
|
+
|
1628
|
+
PRICE_ID = :price_id
|
1629
|
+
ITEM_ID = :item_id
|
1630
|
+
PRICE_TYPE = :price_type
|
1631
|
+
CURRENCY = :currency
|
1632
|
+
PRICING_UNIT_ID = :pricing_unit_id
|
1633
|
+
|
1634
|
+
# @!method self.values
|
1635
|
+
# @return [Array<Symbol>]
|
1636
|
+
end
|
1637
|
+
|
1638
|
+
# Should prices that match the filter be included or excluded.
|
1639
|
+
#
|
1640
|
+
# @see Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::Filter#operator
|
1641
|
+
module Operator
|
1642
|
+
extend Orb::Internal::Type::Enum
|
1643
|
+
|
1644
|
+
INCLUDES = :includes
|
1645
|
+
EXCLUDES = :excludes
|
1646
|
+
|
1647
|
+
# @!method self.values
|
1648
|
+
# @return [Array<Symbol>]
|
1649
|
+
end
|
1650
|
+
end
|
997
1651
|
end
|
998
1652
|
|
999
1653
|
# @see Orb::Models::SubscriptionTriggerPhaseResponse#pending_subscription_change
|