orb-billing 0.5.1 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal/type/array_of.rb +8 -0
- data/lib/orb/internal/type/base_model.rb +7 -0
- data/lib/orb/internal/type/boolean.rb +8 -0
- data/lib/orb/internal/type/enum.rb +12 -0
- data/lib/orb/internal/type/file_input.rb +7 -0
- data/lib/orb/internal/type/hash_of.rb +8 -0
- data/lib/orb/internal/type/union.rb +12 -0
- data/lib/orb/internal/type/unknown.rb +8 -0
- data/lib/orb/internal/util.rb +45 -0
- 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 -10
- data/lib/orb/models/coupon_create_params.rb +3 -9
- 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 -35
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -35
- data/lib/orb/models/customer_update_params.rb +26 -35
- 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_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -14
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -14
- 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 -7
- data/lib/orb/models/evaluate_price_group.rb +0 -4
- 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 -135
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -28
- data/lib/orb/models/invoice_level_discount.rb +1 -5
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -26
- 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 -70
- data/lib/orb/models/plan_create_params.rb +448 -476
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1239
- 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 -78
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_apply_response.rb +14 -36
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -36
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -36
- data/lib/orb/models/subscription_create_params.rb +1002 -1075
- data/lib/orb/models/subscription_create_response.rb +14 -36
- 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 -674
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -36
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -1059
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -36
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -36
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -36
- 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 -36
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -36
- data/lib/orb/models/subscription_usage.rb +26 -35
- 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/models.rb +30 -16
- 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/type/array_of.rbi +6 -0
- data/rbi/orb/internal/type/base_model.rbi +5 -0
- data/rbi/orb/internal/type/boolean.rbi +6 -0
- data/rbi/orb/internal/type/enum.rbi +5 -0
- data/rbi/orb/internal/type/file_input.rbi +5 -0
- data/rbi/orb/internal/type/hash_of.rbi +6 -0
- data/rbi/orb/internal/type/union.rbi +5 -0
- data/rbi/orb/internal/type/unknown.rbi +6 -0
- data/rbi/orb/internal/util.rbi +30 -0
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/coupon.rbi +2 -2
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +2 -65
- data/rbi/orb/models/customers/cost_list_response.rbi +2 -65
- data/rbi/orb/models/evaluate_price_group.rbi +7 -3
- data/rbi/orb/models/invoice.rbi +10 -149
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +10 -133
- data/rbi/orb/models/invoice_line_item_create_response.rbi +8 -114
- data/rbi/orb/models/plan.rbi +8 -134
- data/rbi/orb/models/price.rbi +56 -588
- data/rbi/orb/models/subscription.rbi +6 -99
- data/rbi/orb/models/subscription_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_apply_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_cancel_response.rbi +6 -89
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +6 -89
- data/rbi/orb/models/subscription_create_response.rbi +6 -89
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +2 -65
- data/rbi/orb/models/subscription_price_intervals_response.rbi +6 -89
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +6 -89
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +6 -89
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +6 -89
- data/rbi/orb/models/subscription_update_trial_response.rbi +6 -89
- data/rbi/orb/resources/customers/credits/ledger.rbi +4 -36
- data/rbi/orb/resources/prices/external_price_id.rbi +2 -64
- data/rbi/orb/resources/prices.rbi +4 -130
- data/rbi/orb/resources/subscriptions.rbi +1 -6
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal/type/array_of.rbs +3 -0
- data/sig/orb/internal/type/base_model.rbs +2 -0
- data/sig/orb/internal/type/boolean.rbs +3 -0
- data/sig/orb/internal/type/enum.rbs +2 -0
- data/sig/orb/internal/type/file_input.rbs +2 -0
- data/sig/orb/internal/type/hash_of.rbs +3 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/type/unknown.rbs +3 -0
- data/sig/orb/internal/util.rbs +12 -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
data/rbi/orb/models/plan.rbi
CHANGED
@@ -10,19 +10,7 @@ module Orb
|
|
10
10
|
|
11
11
|
# Adjustments for this plan. If the plan has phases, this includes adjustments
|
12
12
|
# across all phases of the plan.
|
13
|
-
sig
|
14
|
-
returns(
|
15
|
-
T::Array[
|
16
|
-
T.any(
|
17
|
-
Orb::Plan::Adjustment::UsageDiscount,
|
18
|
-
Orb::Plan::Adjustment::AmountDiscount,
|
19
|
-
Orb::Plan::Adjustment::PercentageDiscount,
|
20
|
-
Orb::Plan::Adjustment::Minimum,
|
21
|
-
Orb::Plan::Adjustment::Maximum
|
22
|
-
)
|
23
|
-
]
|
24
|
-
)
|
25
|
-
end
|
13
|
+
sig { returns(T::Array[Orb::Plan::Adjustment::Variants]) }
|
26
14
|
attr_accessor :adjustments
|
27
15
|
|
28
16
|
sig { returns(T.nilable(Orb::Plan::BasePlan)) }
|
@@ -52,18 +40,7 @@ module Orb
|
|
52
40
|
sig { returns(String) }
|
53
41
|
attr_accessor :description
|
54
42
|
|
55
|
-
sig
|
56
|
-
returns(
|
57
|
-
T.nilable(
|
58
|
-
T.any(
|
59
|
-
Orb::PercentageDiscount,
|
60
|
-
Orb::TrialDiscount,
|
61
|
-
Orb::UsageDiscount,
|
62
|
-
Orb::AmountDiscount
|
63
|
-
)
|
64
|
-
)
|
65
|
-
)
|
66
|
-
end
|
43
|
+
sig { returns(T.nilable(Orb::Discount::Variants)) }
|
67
44
|
attr_accessor :discount
|
68
45
|
|
69
46
|
# An optional user-defined ID for this plan resource, used throughout the system
|
@@ -118,42 +95,7 @@ module Orb
|
|
118
95
|
|
119
96
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
120
97
|
# phases of the plan.
|
121
|
-
sig
|
122
|
-
returns(
|
123
|
-
T::Array[
|
124
|
-
T.any(
|
125
|
-
Orb::Price::Unit,
|
126
|
-
Orb::Price::Package,
|
127
|
-
Orb::Price::Matrix,
|
128
|
-
Orb::Price::Tiered,
|
129
|
-
Orb::Price::TieredBps,
|
130
|
-
Orb::Price::Bps,
|
131
|
-
Orb::Price::BulkBps,
|
132
|
-
Orb::Price::Bulk,
|
133
|
-
Orb::Price::ThresholdTotalAmount,
|
134
|
-
Orb::Price::TieredPackage,
|
135
|
-
Orb::Price::GroupedTiered,
|
136
|
-
Orb::Price::TieredWithMinimum,
|
137
|
-
Orb::Price::TieredPackageWithMinimum,
|
138
|
-
Orb::Price::PackageWithAllocation,
|
139
|
-
Orb::Price::UnitWithPercent,
|
140
|
-
Orb::Price::MatrixWithAllocation,
|
141
|
-
Orb::Price::TieredWithProration,
|
142
|
-
Orb::Price::UnitWithProration,
|
143
|
-
Orb::Price::GroupedAllocation,
|
144
|
-
Orb::Price::GroupedWithProratedMinimum,
|
145
|
-
Orb::Price::GroupedWithMeteredMinimum,
|
146
|
-
Orb::Price::MatrixWithDisplayName,
|
147
|
-
Orb::Price::BulkWithProration,
|
148
|
-
Orb::Price::GroupedTieredPackage,
|
149
|
-
Orb::Price::MaxGroupTieredPackage,
|
150
|
-
Orb::Price::ScalableMatrixWithUnitPricing,
|
151
|
-
Orb::Price::ScalableMatrixWithTieredPricing,
|
152
|
-
Orb::Price::CumulativeGroupedBulk
|
153
|
-
)
|
154
|
-
]
|
155
|
-
)
|
156
|
-
end
|
98
|
+
sig { returns(T::Array[Orb::Price::Variants]) }
|
157
99
|
attr_accessor :prices
|
158
100
|
|
159
101
|
sig { returns(Orb::Plan::Product) }
|
@@ -311,31 +253,14 @@ module Orb
|
|
311
253
|
override.returns(
|
312
254
|
{
|
313
255
|
id: String,
|
314
|
-
adjustments:
|
315
|
-
T::Array[
|
316
|
-
T.any(
|
317
|
-
Orb::Plan::Adjustment::UsageDiscount,
|
318
|
-
Orb::Plan::Adjustment::AmountDiscount,
|
319
|
-
Orb::Plan::Adjustment::PercentageDiscount,
|
320
|
-
Orb::Plan::Adjustment::Minimum,
|
321
|
-
Orb::Plan::Adjustment::Maximum
|
322
|
-
)
|
323
|
-
],
|
256
|
+
adjustments: T::Array[Orb::Plan::Adjustment::Variants],
|
324
257
|
base_plan: T.nilable(Orb::Plan::BasePlan),
|
325
258
|
base_plan_id: T.nilable(String),
|
326
259
|
created_at: Time,
|
327
260
|
currency: String,
|
328
261
|
default_invoice_memo: T.nilable(String),
|
329
262
|
description: String,
|
330
|
-
discount:
|
331
|
-
T.nilable(
|
332
|
-
T.any(
|
333
|
-
Orb::PercentageDiscount,
|
334
|
-
Orb::TrialDiscount,
|
335
|
-
Orb::UsageDiscount,
|
336
|
-
Orb::AmountDiscount
|
337
|
-
)
|
338
|
-
),
|
263
|
+
discount: T.nilable(Orb::Discount::Variants),
|
339
264
|
external_plan_id: T.nilable(String),
|
340
265
|
invoicing_currency: String,
|
341
266
|
maximum: T.nilable(Orb::Plan::Maximum),
|
@@ -346,39 +271,7 @@ module Orb
|
|
346
271
|
name: String,
|
347
272
|
net_terms: T.nilable(Integer),
|
348
273
|
plan_phases: T.nilable(T::Array[Orb::Plan::PlanPhase]),
|
349
|
-
prices:
|
350
|
-
T::Array[
|
351
|
-
T.any(
|
352
|
-
Orb::Price::Unit,
|
353
|
-
Orb::Price::Package,
|
354
|
-
Orb::Price::Matrix,
|
355
|
-
Orb::Price::Tiered,
|
356
|
-
Orb::Price::TieredBps,
|
357
|
-
Orb::Price::Bps,
|
358
|
-
Orb::Price::BulkBps,
|
359
|
-
Orb::Price::Bulk,
|
360
|
-
Orb::Price::ThresholdTotalAmount,
|
361
|
-
Orb::Price::TieredPackage,
|
362
|
-
Orb::Price::GroupedTiered,
|
363
|
-
Orb::Price::TieredWithMinimum,
|
364
|
-
Orb::Price::TieredPackageWithMinimum,
|
365
|
-
Orb::Price::PackageWithAllocation,
|
366
|
-
Orb::Price::UnitWithPercent,
|
367
|
-
Orb::Price::MatrixWithAllocation,
|
368
|
-
Orb::Price::TieredWithProration,
|
369
|
-
Orb::Price::UnitWithProration,
|
370
|
-
Orb::Price::GroupedAllocation,
|
371
|
-
Orb::Price::GroupedWithProratedMinimum,
|
372
|
-
Orb::Price::GroupedWithMeteredMinimum,
|
373
|
-
Orb::Price::MatrixWithDisplayName,
|
374
|
-
Orb::Price::BulkWithProration,
|
375
|
-
Orb::Price::GroupedTieredPackage,
|
376
|
-
Orb::Price::MaxGroupTieredPackage,
|
377
|
-
Orb::Price::ScalableMatrixWithUnitPricing,
|
378
|
-
Orb::Price::ScalableMatrixWithTieredPricing,
|
379
|
-
Orb::Price::CumulativeGroupedBulk
|
380
|
-
)
|
381
|
-
],
|
274
|
+
prices: T::Array[Orb::Price::Variants],
|
382
275
|
product: Orb::Plan::Product,
|
383
276
|
status: Orb::Plan::Status::TaggedSymbol,
|
384
277
|
trial_config: Orb::Plan::TrialConfig,
|
@@ -955,18 +848,7 @@ module Orb
|
|
955
848
|
sig { returns(T.nilable(String)) }
|
956
849
|
attr_accessor :description
|
957
850
|
|
958
|
-
sig
|
959
|
-
returns(
|
960
|
-
T.nilable(
|
961
|
-
T.any(
|
962
|
-
Orb::PercentageDiscount,
|
963
|
-
Orb::TrialDiscount,
|
964
|
-
Orb::UsageDiscount,
|
965
|
-
Orb::AmountDiscount
|
966
|
-
)
|
967
|
-
)
|
968
|
-
)
|
969
|
-
end
|
851
|
+
sig { returns(T.nilable(Orb::Discount::Variants)) }
|
970
852
|
attr_accessor :discount
|
971
853
|
|
972
854
|
# How many terms of length `duration_unit` this phase is active for. If null, this
|
@@ -1055,15 +937,7 @@ module Orb
|
|
1055
937
|
{
|
1056
938
|
id: String,
|
1057
939
|
description: T.nilable(String),
|
1058
|
-
discount:
|
1059
|
-
T.nilable(
|
1060
|
-
T.any(
|
1061
|
-
Orb::PercentageDiscount,
|
1062
|
-
Orb::TrialDiscount,
|
1063
|
-
Orb::UsageDiscount,
|
1064
|
-
Orb::AmountDiscount
|
1065
|
-
)
|
1066
|
-
),
|
940
|
+
discount: T.nilable(Orb::Discount::Variants),
|
1067
941
|
duration: T.nilable(Integer),
|
1068
942
|
duration_unit:
|
1069
943
|
T.nilable(Orb::Plan::PlanPhase::DurationUnit::TaggedSymbol),
|