orb-billing 0.5.2 → 0.5.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +25 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal/util.rb +3 -1
- data/lib/orb/internal.rb +3 -0
- data/lib/orb/models/alert.rb +23 -23
- data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +5 -5
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +6 -6
- data/lib/orb/models/coupon_create_params.rb +3 -3
- data/lib/orb/models/credit_note.rb +33 -33
- data/lib/orb/models/credit_note_create_params.rb +4 -4
- data/lib/orb/models/customer.rb +39 -39
- data/lib/orb/models/customer_create_params.rb +26 -26
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -26
- data/lib/orb/models/customer_update_params.rb +26 -26
- data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/dimensional_price_groups.rb +4 -4
- data/lib/orb/models/discount.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +3 -3
- data/lib/orb/models/events/event_volumes.rb +2 -2
- data/lib/orb/models/invoice.rb +114 -113
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -6
- data/lib/orb/models/invoice_level_discount.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -4
- data/lib/orb/models/invoice_list_params.rb +4 -4
- data/lib/orb/models/item.rb +5 -5
- data/lib/orb/models/item_update_params.rb +5 -5
- data/lib/orb/models/percentage_discount.rb +5 -5
- data/lib/orb/models/plan.rb +58 -58
- data/lib/orb/models/plan_create_params.rb +448 -444
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1204
- data/lib/orb/models/price_create_params.rb +50 -50
- data/lib/orb/models/price_evaluate_response.rb +2 -2
- data/lib/orb/models/subscription.rb +58 -56
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_apply_response.rb +14 -14
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -14
- data/lib/orb/models/subscription_create_params.rb +1002 -987
- data/lib/orb/models/subscription_create_response.rb +14 -14
- data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
- data/lib/orb/models/subscription_list_params.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +596 -585
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -14
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -971
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -14
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -14
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -14
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -14
- data/lib/orb/models/subscription_usage.rb +26 -26
- data/lib/orb/models/subscriptions.rb +4 -4
- data/lib/orb/models/trial_discount.rb +5 -5
- data/lib/orb/models/usage_discount.rb +5 -5
- data/lib/orb/resources/alerts.rb +15 -15
- data/lib/orb/resources/coupons/subscriptions.rb +1 -1
- data/lib/orb/resources/coupons.rb +5 -5
- data/lib/orb/resources/credit_notes.rb +5 -5
- data/lib/orb/resources/customers/balance_transactions.rb +1 -1
- data/lib/orb/resources/customers/costs.rb +2 -2
- data/lib/orb/resources/customers/credits/ledger.rb +10 -10
- data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
- data/lib/orb/resources/customers.rb +30 -30
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
- data/lib/orb/resources/dimensional_price_groups.rb +3 -3
- data/lib/orb/resources/events/volume.rb +1 -1
- data/lib/orb/resources/events.rb +1 -1
- data/lib/orb/resources/invoices.rb +12 -12
- data/lib/orb/resources/items.rb +5 -5
- data/lib/orb/resources/metrics.rb +4 -4
- data/lib/orb/resources/plans/external_plan_id.rb +2 -2
- data/lib/orb/resources/plans.rb +7 -7
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +17 -17
- data/lib/orb/resources/subscriptions.rb +32 -32
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +26 -72
- data/rbi/orb/models/subscription_update_trial_params.rbi +14 -3
- data/rbi/orb/resources/subscriptions.rbi +4 -1
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +32 -4
- data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
- data/sig/orb/models/alert_disable_params.rbs +5 -0
- data/sig/orb/models/alert_enable_params.rbs +5 -0
- data/sig/orb/models/alert_list_params.rbs +13 -0
- data/sig/orb/models/alert_retrieve_params.rbs +2 -0
- data/sig/orb/models/alert_update_params.rbs +7 -0
- data/sig/orb/models/amount_discount.rbs +11 -4
- data/sig/orb/models/billable_metric.rbs +13 -4
- data/sig/orb/models/coupon.rbs +14 -4
- data/sig/orb/models/coupon_archive_params.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +15 -0
- data/sig/orb/models/coupon_fetch_params.rbs +2 -0
- data/sig/orb/models/coupon_list_params.rbs +8 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
- data/sig/orb/models/credit_note.rbs +88 -20
- data/sig/orb/models/credit_note_create_params.rbs +9 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
- data/sig/orb/models/credit_note_list_params.rbs +10 -0
- data/sig/orb/models/customer.rbs +86 -16
- data/sig/orb/models/customer_create_params.rbs +79 -8
- data/sig/orb/models/customer_delete_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_params.rbs +2 -0
- data/sig/orb/models/customer_list_params.rbs +10 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
- data/sig/orb/models/customer_update_params.rbs +78 -8
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
- data/sig/orb/models/customers/cost_list_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_response.rbs +20 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
- data/sig/orb/models/customers/credit_list_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_response.rbs +10 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
- data/sig/orb/models/dimensional_price_group.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups.rbs +5 -0
- data/sig/orb/models/evaluate_price_group.rbs +10 -4
- data/sig/orb/models/event_deprecate_params.rbs +2 -0
- data/sig/orb/models/event_deprecate_response.rbs +2 -0
- data/sig/orb/models/event_ingest_params.rbs +16 -0
- data/sig/orb/models/event_ingest_response.rbs +15 -0
- data/sig/orb/models/event_search_params.rbs +7 -0
- data/sig/orb/models/event_search_response.rbs +12 -0
- data/sig/orb/models/event_update_params.rbs +9 -0
- data/sig/orb/models/event_update_response.rbs +2 -0
- data/sig/orb/models/events/backfill_close_params.rbs +2 -0
- data/sig/orb/models/events/backfill_close_response.rbs +14 -0
- data/sig/orb/models/events/backfill_create_params.rbs +11 -0
- data/sig/orb/models/events/backfill_create_response.rbs +14 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
- data/sig/orb/models/events/backfill_list_params.rbs +6 -0
- data/sig/orb/models/events/backfill_list_response.rbs +14 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
- data/sig/orb/models/events/event_volumes.rbs +8 -0
- data/sig/orb/models/events/volume_list_params.rbs +8 -0
- data/sig/orb/models/invoice.rbs +293 -36
- data/sig/orb/models/invoice_create_params.rbs +30 -4
- data/sig/orb/models/invoice_fetch_params.rbs +2 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
- data/sig/orb/models/invoice_issue_params.rbs +5 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
- data/sig/orb/models/invoice_list_params.rbs +27 -4
- data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
- data/sig/orb/models/invoice_pay_params.rbs +2 -0
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +2 -0
- data/sig/orb/models/item.rbs +16 -4
- data/sig/orb/models/item_create_params.rbs +2 -0
- data/sig/orb/models/item_fetch_params.rbs +2 -0
- data/sig/orb/models/item_list_params.rbs +6 -0
- data/sig/orb/models/item_update_params.rbs +15 -4
- data/sig/orb/models/metric_create_params.rbs +9 -0
- data/sig/orb/models/metric_fetch_params.rbs +2 -0
- data/sig/orb/models/metric_list_params.rbs +10 -0
- data/sig/orb/models/metric_update_params.rbs +5 -0
- data/sig/orb/models/pagination_metadata.rbs +2 -0
- data/sig/orb/models/percentage_discount.rbs +11 -4
- data/sig/orb/models/plan.rbs +141 -16
- data/sig/orb/models/plan_create_params.rbs +1070 -304
- data/sig/orb/models/plan_fetch_params.rbs +2 -0
- data/sig/orb/models/plan_list_params.rbs +11 -0
- data/sig/orb/models/plan_update_params.rbs +6 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
- data/sig/orb/models/price.rbs +2148 -460
- data/sig/orb/models/price_create_params.rbs +130 -8
- data/sig/orb/models/price_evaluate_params.rbs +10 -0
- data/sig/orb/models/price_evaluate_response.rbs +2 -0
- data/sig/orb/models/price_fetch_params.rbs +2 -0
- data/sig/orb/models/price_list_params.rbs +6 -0
- data/sig/orb/models/price_update_params.rbs +5 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
- data/sig/orb/models/subscription.rbs +177 -12
- data/sig/orb/models/subscription_cancel_params.rbs +7 -0
- data/sig/orb/models/subscription_cancel_response.rbs +173 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
- data/sig/orb/models/subscription_create_params.rbs +2368 -632
- data/sig/orb/models/subscription_create_response.rbs +173 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
- data/sig/orb/models/subscription_fetch_params.rbs +2 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
- data/sig/orb/models/subscription_list_params.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
- data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
- data/sig/orb/models/subscription_update_params.rbs +9 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
- data/sig/orb/models/subscription_usage.rbs +48 -8
- data/sig/orb/models/subscriptions.rbs +5 -0
- data/sig/orb/models/top_level_ping_params.rbs +2 -0
- data/sig/orb/models/top_level_ping_response.rbs +2 -0
- data/sig/orb/models/trial_discount.rbs +12 -4
- data/sig/orb/models/usage_discount.rbs +11 -4
- data/sig/orb/resources/invoices.rbs +1 -1
- data/sig/orb/resources/plans.rbs +1 -1
- metadata +2 -2
@@ -116,6 +116,36 @@ module Orb
|
|
116
116
|
?changed_resources: Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources?
|
117
117
|
) -> void
|
118
118
|
|
119
|
+
def to_hash: -> {
|
120
|
+
id: String,
|
121
|
+
active_plan_phase_order: Integer?,
|
122
|
+
adjustment_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval],
|
123
|
+
auto_collection: bool?,
|
124
|
+
billing_cycle_anchor_configuration: Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration,
|
125
|
+
billing_cycle_day: Integer,
|
126
|
+
created_at: Time,
|
127
|
+
current_billing_period_end_date: Time?,
|
128
|
+
current_billing_period_start_date: Time?,
|
129
|
+
customer: Orb::Customer,
|
130
|
+
default_invoice_memo: String?,
|
131
|
+
discount_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::discount_interval],
|
132
|
+
end_date: Time?,
|
133
|
+
fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule],
|
134
|
+
invoicing_threshold: String?,
|
135
|
+
maximum_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval],
|
136
|
+
metadata: ::Hash[Symbol, String],
|
137
|
+
minimum_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval],
|
138
|
+
net_terms: Integer,
|
139
|
+
pending_subscription_change: Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange?,
|
140
|
+
plan: Orb::Plan,
|
141
|
+
price_intervals: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval],
|
142
|
+
redeemed_coupon: Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon?,
|
143
|
+
start_date: Time,
|
144
|
+
status: Orb::Models::SubscriptionSchedulePlanChangeResponse::status,
|
145
|
+
trial_info: Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo,
|
146
|
+
changed_resources: Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources?
|
147
|
+
}
|
148
|
+
|
119
149
|
type adjustment_interval =
|
120
150
|
{
|
121
151
|
id: String,
|
@@ -144,6 +174,14 @@ module Orb
|
|
144
174
|
start_date: Time
|
145
175
|
) -> void
|
146
176
|
|
177
|
+
def to_hash: -> {
|
178
|
+
id: String,
|
179
|
+
adjustment: Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::adjustment,
|
180
|
+
applies_to_price_interval_ids: ::Array[String],
|
181
|
+
end_date: Time?,
|
182
|
+
start_date: Time
|
183
|
+
}
|
184
|
+
|
147
185
|
type adjustment =
|
148
186
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount
|
149
187
|
| Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount
|
@@ -189,6 +227,16 @@ module Orb
|
|
189
227
|
usage_discount: Float,
|
190
228
|
?adjustment_type: :usage_discount
|
191
229
|
) -> void
|
230
|
+
|
231
|
+
def to_hash: -> {
|
232
|
+
id: String,
|
233
|
+
adjustment_type: :usage_discount,
|
234
|
+
applies_to_price_ids: ::Array[String],
|
235
|
+
is_invoice_level: bool,
|
236
|
+
plan_phase_order: Integer?,
|
237
|
+
reason: String?,
|
238
|
+
usage_discount: Float
|
239
|
+
}
|
192
240
|
end
|
193
241
|
|
194
242
|
type amount_discount =
|
@@ -226,6 +274,16 @@ module Orb
|
|
226
274
|
reason: String?,
|
227
275
|
?adjustment_type: :amount_discount
|
228
276
|
) -> void
|
277
|
+
|
278
|
+
def to_hash: -> {
|
279
|
+
id: String,
|
280
|
+
adjustment_type: :amount_discount,
|
281
|
+
amount_discount: String,
|
282
|
+
applies_to_price_ids: ::Array[String],
|
283
|
+
is_invoice_level: bool,
|
284
|
+
plan_phase_order: Integer?,
|
285
|
+
reason: String?
|
286
|
+
}
|
229
287
|
end
|
230
288
|
|
231
289
|
type percentage_discount =
|
@@ -263,6 +321,16 @@ module Orb
|
|
263
321
|
reason: String?,
|
264
322
|
?adjustment_type: :percentage_discount
|
265
323
|
) -> void
|
324
|
+
|
325
|
+
def to_hash: -> {
|
326
|
+
id: String,
|
327
|
+
adjustment_type: :percentage_discount,
|
328
|
+
applies_to_price_ids: ::Array[String],
|
329
|
+
is_invoice_level: bool,
|
330
|
+
percentage_discount: Float,
|
331
|
+
plan_phase_order: Integer?,
|
332
|
+
reason: String?
|
333
|
+
}
|
266
334
|
end
|
267
335
|
|
268
336
|
type minimum =
|
@@ -304,6 +372,17 @@ module Orb
|
|
304
372
|
reason: String?,
|
305
373
|
?adjustment_type: :minimum
|
306
374
|
) -> void
|
375
|
+
|
376
|
+
def to_hash: -> {
|
377
|
+
id: String,
|
378
|
+
adjustment_type: :minimum,
|
379
|
+
applies_to_price_ids: ::Array[String],
|
380
|
+
is_invoice_level: bool,
|
381
|
+
item_id: String,
|
382
|
+
minimum_amount: String,
|
383
|
+
plan_phase_order: Integer?,
|
384
|
+
reason: String?
|
385
|
+
}
|
307
386
|
end
|
308
387
|
|
309
388
|
type maximum =
|
@@ -341,6 +420,16 @@ module Orb
|
|
341
420
|
reason: String?,
|
342
421
|
?adjustment_type: :maximum
|
343
422
|
) -> void
|
423
|
+
|
424
|
+
def to_hash: -> {
|
425
|
+
id: String,
|
426
|
+
adjustment_type: :maximum,
|
427
|
+
applies_to_price_ids: ::Array[String],
|
428
|
+
is_invoice_level: bool,
|
429
|
+
maximum_amount: String,
|
430
|
+
plan_phase_order: Integer?,
|
431
|
+
reason: String?
|
432
|
+
}
|
344
433
|
end
|
345
434
|
|
346
435
|
def self?.variants: -> ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::adjustment]
|
@@ -362,6 +451,8 @@ module Orb
|
|
362
451
|
?month: Integer?,
|
363
452
|
?year: Integer?
|
364
453
|
) -> void
|
454
|
+
|
455
|
+
def to_hash: -> { day: Integer, month: Integer?, year: Integer? }
|
365
456
|
end
|
366
457
|
|
367
458
|
type discount_interval =
|
@@ -403,6 +494,15 @@ module Orb
|
|
403
494
|
start_date: Time,
|
404
495
|
?discount_type: :amount
|
405
496
|
) -> void
|
497
|
+
|
498
|
+
def to_hash: -> {
|
499
|
+
amount_discount: String,
|
500
|
+
applies_to_price_ids: ::Array[String],
|
501
|
+
applies_to_price_interval_ids: ::Array[String],
|
502
|
+
discount_type: :amount,
|
503
|
+
end_date: Time?,
|
504
|
+
start_date: Time
|
505
|
+
}
|
406
506
|
end
|
407
507
|
|
408
508
|
type percentage =
|
@@ -436,6 +536,15 @@ module Orb
|
|
436
536
|
start_date: Time,
|
437
537
|
?discount_type: :percentage
|
438
538
|
) -> void
|
539
|
+
|
540
|
+
def to_hash: -> {
|
541
|
+
applies_to_price_ids: ::Array[String],
|
542
|
+
applies_to_price_interval_ids: ::Array[String],
|
543
|
+
discount_type: :percentage,
|
544
|
+
end_date: Time?,
|
545
|
+
percentage_discount: Float,
|
546
|
+
start_date: Time
|
547
|
+
}
|
439
548
|
end
|
440
549
|
|
441
550
|
type usage =
|
@@ -469,6 +578,15 @@ module Orb
|
|
469
578
|
usage_discount: Float,
|
470
579
|
?discount_type: :usage
|
471
580
|
) -> void
|
581
|
+
|
582
|
+
def to_hash: -> {
|
583
|
+
applies_to_price_ids: ::Array[String],
|
584
|
+
applies_to_price_interval_ids: ::Array[String],
|
585
|
+
discount_type: :usage,
|
586
|
+
end_date: Time?,
|
587
|
+
start_date: Time,
|
588
|
+
usage_discount: Float
|
589
|
+
}
|
472
590
|
end
|
473
591
|
|
474
592
|
def self?.variants: -> ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::discount_interval]
|
@@ -492,6 +610,13 @@ module Orb
|
|
492
610
|
quantity: Float,
|
493
611
|
start_date: Time
|
494
612
|
) -> void
|
613
|
+
|
614
|
+
def to_hash: -> {
|
615
|
+
end_date: Time?,
|
616
|
+
price_id: String,
|
617
|
+
quantity: Float,
|
618
|
+
start_date: Time
|
619
|
+
}
|
495
620
|
end
|
496
621
|
|
497
622
|
type maximum_interval =
|
@@ -521,6 +646,14 @@ module Orb
|
|
521
646
|
maximum_amount: String,
|
522
647
|
start_date: Time
|
523
648
|
) -> void
|
649
|
+
|
650
|
+
def to_hash: -> {
|
651
|
+
applies_to_price_ids: ::Array[String],
|
652
|
+
applies_to_price_interval_ids: ::Array[String],
|
653
|
+
end_date: Time?,
|
654
|
+
maximum_amount: String,
|
655
|
+
start_date: Time
|
656
|
+
}
|
524
657
|
end
|
525
658
|
|
526
659
|
type minimum_interval =
|
@@ -550,6 +683,14 @@ module Orb
|
|
550
683
|
minimum_amount: String,
|
551
684
|
start_date: Time
|
552
685
|
) -> void
|
686
|
+
|
687
|
+
def to_hash: -> {
|
688
|
+
applies_to_price_ids: ::Array[String],
|
689
|
+
applies_to_price_interval_ids: ::Array[String],
|
690
|
+
end_date: Time?,
|
691
|
+
minimum_amount: String,
|
692
|
+
start_date: Time
|
693
|
+
}
|
553
694
|
end
|
554
695
|
|
555
696
|
type pending_subscription_change = { id: String }
|
@@ -558,6 +699,8 @@ module Orb
|
|
558
699
|
attr_accessor id: String
|
559
700
|
|
560
701
|
def initialize: (id: String) -> void
|
702
|
+
|
703
|
+
def to_hash: -> { id: String }
|
561
704
|
end
|
562
705
|
|
563
706
|
type price_interval =
|
@@ -608,6 +751,19 @@ module Orb
|
|
608
751
|
usage_customer_ids: ::Array[String]?
|
609
752
|
) -> void
|
610
753
|
|
754
|
+
def to_hash: -> {
|
755
|
+
id: String,
|
756
|
+
billing_cycle_day: Integer,
|
757
|
+
current_billing_period_end_date: Time?,
|
758
|
+
current_billing_period_start_date: Time?,
|
759
|
+
end_date: Time?,
|
760
|
+
filter: String?,
|
761
|
+
fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition]?,
|
762
|
+
price: Orb::Models::price,
|
763
|
+
start_date: Time,
|
764
|
+
usage_customer_ids: ::Array[String]?
|
765
|
+
}
|
766
|
+
|
611
767
|
type fixed_fee_quantity_transition =
|
612
768
|
{ effective_date: Time, price_id: String, quantity: Integer }
|
613
769
|
|
@@ -623,6 +779,12 @@ module Orb
|
|
623
779
|
price_id: String,
|
624
780
|
quantity: Integer
|
625
781
|
) -> void
|
782
|
+
|
783
|
+
def to_hash: -> {
|
784
|
+
effective_date: Time,
|
785
|
+
price_id: String,
|
786
|
+
quantity: Integer
|
787
|
+
}
|
626
788
|
end
|
627
789
|
end
|
628
790
|
|
@@ -641,6 +803,8 @@ module Orb
|
|
641
803
|
end_date: Time?,
|
642
804
|
start_date: Time
|
643
805
|
) -> void
|
806
|
+
|
807
|
+
def to_hash: -> { coupon_id: String, end_date: Time?, start_date: Time }
|
644
808
|
end
|
645
809
|
|
646
810
|
type status = :active | :ended | :upcoming
|
@@ -661,6 +825,8 @@ module Orb
|
|
661
825
|
attr_accessor end_date: Time?
|
662
826
|
|
663
827
|
def initialize: (end_date: Time?) -> void
|
828
|
+
|
829
|
+
def to_hash: -> { end_date: Time? }
|
664
830
|
end
|
665
831
|
|
666
832
|
type changed_resources =
|
@@ -686,6 +852,13 @@ module Orb
|
|
686
852
|
voided_credit_notes: ::Array[Orb::CreditNote],
|
687
853
|
voided_invoices: ::Array[Orb::Invoice]
|
688
854
|
) -> void
|
855
|
+
|
856
|
+
def to_hash: -> {
|
857
|
+
created_credit_notes: ::Array[Orb::CreditNote],
|
858
|
+
created_invoices: ::Array[Orb::Invoice],
|
859
|
+
voided_credit_notes: ::Array[Orb::CreditNote],
|
860
|
+
voided_invoices: ::Array[Orb::Invoice]
|
861
|
+
}
|
689
862
|
end
|
690
863
|
end
|
691
864
|
end
|
@@ -116,6 +116,36 @@ module Orb
|
|
116
116
|
?changed_resources: Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources?
|
117
117
|
) -> void
|
118
118
|
|
119
|
+
def to_hash: -> {
|
120
|
+
id: String,
|
121
|
+
active_plan_phase_order: Integer?,
|
122
|
+
adjustment_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval],
|
123
|
+
auto_collection: bool?,
|
124
|
+
billing_cycle_anchor_configuration: Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration,
|
125
|
+
billing_cycle_day: Integer,
|
126
|
+
created_at: Time,
|
127
|
+
current_billing_period_end_date: Time?,
|
128
|
+
current_billing_period_start_date: Time?,
|
129
|
+
customer: Orb::Customer,
|
130
|
+
default_invoice_memo: String?,
|
131
|
+
discount_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::discount_interval],
|
132
|
+
end_date: Time?,
|
133
|
+
fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::FixedFeeQuantitySchedule],
|
134
|
+
invoicing_threshold: String?,
|
135
|
+
maximum_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval],
|
136
|
+
metadata: ::Hash[Symbol, String],
|
137
|
+
minimum_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval],
|
138
|
+
net_terms: Integer,
|
139
|
+
pending_subscription_change: Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange?,
|
140
|
+
plan: Orb::Plan,
|
141
|
+
price_intervals: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval],
|
142
|
+
redeemed_coupon: Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon?,
|
143
|
+
start_date: Time,
|
144
|
+
status: Orb::Models::SubscriptionTriggerPhaseResponse::status,
|
145
|
+
trial_info: Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo,
|
146
|
+
changed_resources: Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources?
|
147
|
+
}
|
148
|
+
|
119
149
|
type adjustment_interval =
|
120
150
|
{
|
121
151
|
id: String,
|
@@ -144,6 +174,14 @@ module Orb
|
|
144
174
|
start_date: Time
|
145
175
|
) -> void
|
146
176
|
|
177
|
+
def to_hash: -> {
|
178
|
+
id: String,
|
179
|
+
adjustment: Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::adjustment,
|
180
|
+
applies_to_price_interval_ids: ::Array[String],
|
181
|
+
end_date: Time?,
|
182
|
+
start_date: Time
|
183
|
+
}
|
184
|
+
|
147
185
|
type adjustment =
|
148
186
|
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount
|
149
187
|
| Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount
|
@@ -189,6 +227,16 @@ module Orb
|
|
189
227
|
usage_discount: Float,
|
190
228
|
?adjustment_type: :usage_discount
|
191
229
|
) -> void
|
230
|
+
|
231
|
+
def to_hash: -> {
|
232
|
+
id: String,
|
233
|
+
adjustment_type: :usage_discount,
|
234
|
+
applies_to_price_ids: ::Array[String],
|
235
|
+
is_invoice_level: bool,
|
236
|
+
plan_phase_order: Integer?,
|
237
|
+
reason: String?,
|
238
|
+
usage_discount: Float
|
239
|
+
}
|
192
240
|
end
|
193
241
|
|
194
242
|
type amount_discount =
|
@@ -226,6 +274,16 @@ module Orb
|
|
226
274
|
reason: String?,
|
227
275
|
?adjustment_type: :amount_discount
|
228
276
|
) -> void
|
277
|
+
|
278
|
+
def to_hash: -> {
|
279
|
+
id: String,
|
280
|
+
adjustment_type: :amount_discount,
|
281
|
+
amount_discount: String,
|
282
|
+
applies_to_price_ids: ::Array[String],
|
283
|
+
is_invoice_level: bool,
|
284
|
+
plan_phase_order: Integer?,
|
285
|
+
reason: String?
|
286
|
+
}
|
229
287
|
end
|
230
288
|
|
231
289
|
type percentage_discount =
|
@@ -263,6 +321,16 @@ module Orb
|
|
263
321
|
reason: String?,
|
264
322
|
?adjustment_type: :percentage_discount
|
265
323
|
) -> void
|
324
|
+
|
325
|
+
def to_hash: -> {
|
326
|
+
id: String,
|
327
|
+
adjustment_type: :percentage_discount,
|
328
|
+
applies_to_price_ids: ::Array[String],
|
329
|
+
is_invoice_level: bool,
|
330
|
+
percentage_discount: Float,
|
331
|
+
plan_phase_order: Integer?,
|
332
|
+
reason: String?
|
333
|
+
}
|
266
334
|
end
|
267
335
|
|
268
336
|
type minimum =
|
@@ -304,6 +372,17 @@ module Orb
|
|
304
372
|
reason: String?,
|
305
373
|
?adjustment_type: :minimum
|
306
374
|
) -> void
|
375
|
+
|
376
|
+
def to_hash: -> {
|
377
|
+
id: String,
|
378
|
+
adjustment_type: :minimum,
|
379
|
+
applies_to_price_ids: ::Array[String],
|
380
|
+
is_invoice_level: bool,
|
381
|
+
item_id: String,
|
382
|
+
minimum_amount: String,
|
383
|
+
plan_phase_order: Integer?,
|
384
|
+
reason: String?
|
385
|
+
}
|
307
386
|
end
|
308
387
|
|
309
388
|
type maximum =
|
@@ -341,6 +420,16 @@ module Orb
|
|
341
420
|
reason: String?,
|
342
421
|
?adjustment_type: :maximum
|
343
422
|
) -> void
|
423
|
+
|
424
|
+
def to_hash: -> {
|
425
|
+
id: String,
|
426
|
+
adjustment_type: :maximum,
|
427
|
+
applies_to_price_ids: ::Array[String],
|
428
|
+
is_invoice_level: bool,
|
429
|
+
maximum_amount: String,
|
430
|
+
plan_phase_order: Integer?,
|
431
|
+
reason: String?
|
432
|
+
}
|
344
433
|
end
|
345
434
|
|
346
435
|
def self?.variants: -> ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::adjustment]
|
@@ -362,6 +451,8 @@ module Orb
|
|
362
451
|
?month: Integer?,
|
363
452
|
?year: Integer?
|
364
453
|
) -> void
|
454
|
+
|
455
|
+
def to_hash: -> { day: Integer, month: Integer?, year: Integer? }
|
365
456
|
end
|
366
457
|
|
367
458
|
type discount_interval =
|
@@ -403,6 +494,15 @@ module Orb
|
|
403
494
|
start_date: Time,
|
404
495
|
?discount_type: :amount
|
405
496
|
) -> void
|
497
|
+
|
498
|
+
def to_hash: -> {
|
499
|
+
amount_discount: String,
|
500
|
+
applies_to_price_ids: ::Array[String],
|
501
|
+
applies_to_price_interval_ids: ::Array[String],
|
502
|
+
discount_type: :amount,
|
503
|
+
end_date: Time?,
|
504
|
+
start_date: Time
|
505
|
+
}
|
406
506
|
end
|
407
507
|
|
408
508
|
type percentage =
|
@@ -436,6 +536,15 @@ module Orb
|
|
436
536
|
start_date: Time,
|
437
537
|
?discount_type: :percentage
|
438
538
|
) -> void
|
539
|
+
|
540
|
+
def to_hash: -> {
|
541
|
+
applies_to_price_ids: ::Array[String],
|
542
|
+
applies_to_price_interval_ids: ::Array[String],
|
543
|
+
discount_type: :percentage,
|
544
|
+
end_date: Time?,
|
545
|
+
percentage_discount: Float,
|
546
|
+
start_date: Time
|
547
|
+
}
|
439
548
|
end
|
440
549
|
|
441
550
|
type usage =
|
@@ -469,6 +578,15 @@ module Orb
|
|
469
578
|
usage_discount: Float,
|
470
579
|
?discount_type: :usage
|
471
580
|
) -> void
|
581
|
+
|
582
|
+
def to_hash: -> {
|
583
|
+
applies_to_price_ids: ::Array[String],
|
584
|
+
applies_to_price_interval_ids: ::Array[String],
|
585
|
+
discount_type: :usage,
|
586
|
+
end_date: Time?,
|
587
|
+
start_date: Time,
|
588
|
+
usage_discount: Float
|
589
|
+
}
|
472
590
|
end
|
473
591
|
|
474
592
|
def self?.variants: -> ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::discount_interval]
|
@@ -492,6 +610,13 @@ module Orb
|
|
492
610
|
quantity: Float,
|
493
611
|
start_date: Time
|
494
612
|
) -> void
|
613
|
+
|
614
|
+
def to_hash: -> {
|
615
|
+
end_date: Time?,
|
616
|
+
price_id: String,
|
617
|
+
quantity: Float,
|
618
|
+
start_date: Time
|
619
|
+
}
|
495
620
|
end
|
496
621
|
|
497
622
|
type maximum_interval =
|
@@ -521,6 +646,14 @@ module Orb
|
|
521
646
|
maximum_amount: String,
|
522
647
|
start_date: Time
|
523
648
|
) -> void
|
649
|
+
|
650
|
+
def to_hash: -> {
|
651
|
+
applies_to_price_ids: ::Array[String],
|
652
|
+
applies_to_price_interval_ids: ::Array[String],
|
653
|
+
end_date: Time?,
|
654
|
+
maximum_amount: String,
|
655
|
+
start_date: Time
|
656
|
+
}
|
524
657
|
end
|
525
658
|
|
526
659
|
type minimum_interval =
|
@@ -550,6 +683,14 @@ module Orb
|
|
550
683
|
minimum_amount: String,
|
551
684
|
start_date: Time
|
552
685
|
) -> void
|
686
|
+
|
687
|
+
def to_hash: -> {
|
688
|
+
applies_to_price_ids: ::Array[String],
|
689
|
+
applies_to_price_interval_ids: ::Array[String],
|
690
|
+
end_date: Time?,
|
691
|
+
minimum_amount: String,
|
692
|
+
start_date: Time
|
693
|
+
}
|
553
694
|
end
|
554
695
|
|
555
696
|
type pending_subscription_change = { id: String }
|
@@ -558,6 +699,8 @@ module Orb
|
|
558
699
|
attr_accessor id: String
|
559
700
|
|
560
701
|
def initialize: (id: String) -> void
|
702
|
+
|
703
|
+
def to_hash: -> { id: String }
|
561
704
|
end
|
562
705
|
|
563
706
|
type price_interval =
|
@@ -608,6 +751,19 @@ module Orb
|
|
608
751
|
usage_customer_ids: ::Array[String]?
|
609
752
|
) -> void
|
610
753
|
|
754
|
+
def to_hash: -> {
|
755
|
+
id: String,
|
756
|
+
billing_cycle_day: Integer,
|
757
|
+
current_billing_period_end_date: Time?,
|
758
|
+
current_billing_period_start_date: Time?,
|
759
|
+
end_date: Time?,
|
760
|
+
filter: String?,
|
761
|
+
fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::FixedFeeQuantityTransition]?,
|
762
|
+
price: Orb::Models::price,
|
763
|
+
start_date: Time,
|
764
|
+
usage_customer_ids: ::Array[String]?
|
765
|
+
}
|
766
|
+
|
611
767
|
type fixed_fee_quantity_transition =
|
612
768
|
{ effective_date: Time, price_id: String, quantity: Integer }
|
613
769
|
|
@@ -623,6 +779,12 @@ module Orb
|
|
623
779
|
price_id: String,
|
624
780
|
quantity: Integer
|
625
781
|
) -> void
|
782
|
+
|
783
|
+
def to_hash: -> {
|
784
|
+
effective_date: Time,
|
785
|
+
price_id: String,
|
786
|
+
quantity: Integer
|
787
|
+
}
|
626
788
|
end
|
627
789
|
end
|
628
790
|
|
@@ -641,6 +803,8 @@ module Orb
|
|
641
803
|
end_date: Time?,
|
642
804
|
start_date: Time
|
643
805
|
) -> void
|
806
|
+
|
807
|
+
def to_hash: -> { coupon_id: String, end_date: Time?, start_date: Time }
|
644
808
|
end
|
645
809
|
|
646
810
|
type status = :active | :ended | :upcoming
|
@@ -661,6 +825,8 @@ module Orb
|
|
661
825
|
attr_accessor end_date: Time?
|
662
826
|
|
663
827
|
def initialize: (end_date: Time?) -> void
|
828
|
+
|
829
|
+
def to_hash: -> { end_date: Time? }
|
664
830
|
end
|
665
831
|
|
666
832
|
type changed_resources =
|
@@ -686,6 +852,13 @@ module Orb
|
|
686
852
|
voided_credit_notes: ::Array[Orb::CreditNote],
|
687
853
|
voided_invoices: ::Array[Orb::Invoice]
|
688
854
|
) -> void
|
855
|
+
|
856
|
+
def to_hash: -> {
|
857
|
+
created_credit_notes: ::Array[Orb::CreditNote],
|
858
|
+
created_invoices: ::Array[Orb::Invoice],
|
859
|
+
voided_credit_notes: ::Array[Orb::CreditNote],
|
860
|
+
voided_invoices: ::Array[Orb::Invoice]
|
861
|
+
}
|
689
862
|
end
|
690
863
|
end
|
691
864
|
end
|