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
@@ -88,7 +88,7 @@ module Orb
|
|
88
88
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
89
|
# information on what this timezone parameter influences within Orb.
|
90
90
|
#
|
91
|
-
# @return [Orb::Customer]
|
91
|
+
# @return [Orb::Models::Customer]
|
92
92
|
required :customer, -> { Orb::Customer }
|
93
93
|
|
94
94
|
# @!attribute default_invoice_memo
|
@@ -168,7 +168,7 @@ module Orb
|
|
168
168
|
# subscription. You can see more about how to configure prices in the
|
169
169
|
# [Price resource](/reference/price).
|
170
170
|
#
|
171
|
-
# @return [Orb::Plan]
|
171
|
+
# @return [Orb::Models::Plan]
|
172
172
|
required :plan, -> { Orb::Plan }
|
173
173
|
|
174
174
|
# @!attribute price_intervals
|
@@ -234,7 +234,7 @@ module Orb
|
|
234
234
|
#
|
235
235
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
236
236
|
#
|
237
|
-
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
237
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
238
238
|
#
|
239
239
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
240
240
|
#
|
@@ -256,7 +256,7 @@ module Orb
|
|
256
256
|
#
|
257
257
|
# @param pending_subscription_change [Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
258
258
|
#
|
259
|
-
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
259
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
260
260
|
#
|
261
261
|
# @param price_intervals [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval>] The price intervals for this subscription.
|
262
262
|
#
|
@@ -657,18 +657,6 @@ module Orb
|
|
657
657
|
|
658
658
|
# @!method self.variants
|
659
659
|
# @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Maximum)]
|
660
|
-
|
661
|
-
define_sorbet_constant!(:Variants) do
|
662
|
-
T.type_alias do
|
663
|
-
T.any(
|
664
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
665
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
666
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
667
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Minimum,
|
668
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::AdjustmentInterval::Adjustment::Maximum
|
669
|
-
)
|
670
|
-
end
|
671
|
-
end
|
672
660
|
end
|
673
661
|
end
|
674
662
|
|
@@ -886,16 +874,6 @@ module Orb
|
|
886
874
|
|
887
875
|
# @!method self.variants
|
888
876
|
# @return [Array(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage)]
|
889
|
-
|
890
|
-
define_sorbet_constant!(:Variants) do
|
891
|
-
T.type_alias do
|
892
|
-
T.any(
|
893
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Amount,
|
894
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Percentage,
|
895
|
-
Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::DiscountInterval::Usage
|
896
|
-
)
|
897
|
-
end
|
898
|
-
end
|
899
877
|
end
|
900
878
|
|
901
879
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1097,7 +1075,7 @@ module Orb
|
|
1097
1075
|
# For more on the types of prices, see
|
1098
1076
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1099
1077
|
#
|
1100
|
-
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1078
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1101
1079
|
required :price, union: -> { Orb::Price }
|
1102
1080
|
|
1103
1081
|
# @!attribute start_date
|
@@ -1137,7 +1115,7 @@ module Orb
|
|
1137
1115
|
#
|
1138
1116
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1139
1117
|
#
|
1140
|
-
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1118
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1141
1119
|
#
|
1142
1120
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1143
1121
|
#
|
@@ -1217,25 +1195,25 @@ module Orb
|
|
1217
1195
|
# @!attribute created_credit_notes
|
1218
1196
|
# The credit notes that were created as part of this operation.
|
1219
1197
|
#
|
1220
|
-
# @return [Array<Orb::CreditNote>]
|
1198
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1221
1199
|
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1222
1200
|
|
1223
1201
|
# @!attribute created_invoices
|
1224
1202
|
# The invoices that were created as part of this operation.
|
1225
1203
|
#
|
1226
|
-
# @return [Array<Orb::Invoice>]
|
1204
|
+
# @return [Array<Orb::Models::Invoice>]
|
1227
1205
|
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1228
1206
|
|
1229
1207
|
# @!attribute voided_credit_notes
|
1230
1208
|
# The credit notes that were voided as part of this operation.
|
1231
1209
|
#
|
1232
|
-
# @return [Array<Orb::CreditNote>]
|
1210
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1233
1211
|
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1234
1212
|
|
1235
1213
|
# @!attribute voided_invoices
|
1236
1214
|
# The invoices that were voided as part of this operation.
|
1237
1215
|
#
|
1238
|
-
# @return [Array<Orb::Invoice>]
|
1216
|
+
# @return [Array<Orb::Models::Invoice>]
|
1239
1217
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1240
1218
|
|
1241
1219
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
@@ -1243,13 +1221,13 @@ module Orb
|
|
1243
1221
|
# fetched through the subscription changes API or if the
|
1244
1222
|
# `include_changed_resources` parameter was passed in the request.
|
1245
1223
|
#
|
1246
|
-
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1224
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1247
1225
|
#
|
1248
|
-
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1226
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1249
1227
|
#
|
1250
|
-
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1228
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1251
1229
|
#
|
1252
|
-
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1230
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1253
1231
|
end
|
1254
1232
|
end
|
1255
1233
|
end
|
@@ -31,7 +31,7 @@ module Orb
|
|
31
31
|
# specified, this defaults to `effective_date`. Otherwise, this defaults to
|
32
32
|
# `immediate` unless it's explicitly set to `upcoming_invoice`.
|
33
33
|
#
|
34
|
-
# @return [Symbol, Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption, nil]
|
34
|
+
# @return [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption, nil]
|
35
35
|
optional :change_option, enum: -> { Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption }
|
36
36
|
|
37
37
|
# @!attribute effective_date
|
@@ -52,7 +52,7 @@ module Orb
|
|
52
52
|
#
|
53
53
|
# @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
|
54
54
|
#
|
55
|
-
# @param change_option [Symbol, Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] Determines when the change takes effect. Note that if `effective_date` is specif
|
55
|
+
# @param change_option [Symbol, Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption] Determines when the change takes effect. Note that if `effective_date` is specif
|
56
56
|
#
|
57
57
|
# @param effective_date [Date, nil] The date that the quantity change should take effect, localized to the customer'
|
58
58
|
#
|
@@ -88,7 +88,7 @@ module Orb
|
|
88
88
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
89
|
# information on what this timezone parameter influences within Orb.
|
90
90
|
#
|
91
|
-
# @return [Orb::Customer]
|
91
|
+
# @return [Orb::Models::Customer]
|
92
92
|
required :customer, -> { Orb::Customer }
|
93
93
|
|
94
94
|
# @!attribute default_invoice_memo
|
@@ -168,7 +168,7 @@ module Orb
|
|
168
168
|
# subscription. You can see more about how to configure prices in the
|
169
169
|
# [Price resource](/reference/price).
|
170
170
|
#
|
171
|
-
# @return [Orb::Plan]
|
171
|
+
# @return [Orb::Models::Plan]
|
172
172
|
required :plan, -> { Orb::Plan }
|
173
173
|
|
174
174
|
# @!attribute price_intervals
|
@@ -233,7 +233,7 @@ module Orb
|
|
233
233
|
#
|
234
234
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
235
235
|
#
|
236
|
-
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
236
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
237
237
|
#
|
238
238
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
239
239
|
#
|
@@ -255,7 +255,7 @@ module Orb
|
|
255
255
|
#
|
256
256
|
# @param pending_subscription_change [Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
257
257
|
#
|
258
|
-
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
258
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
259
259
|
#
|
260
260
|
# @param price_intervals [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval>] The price intervals for this subscription.
|
261
261
|
#
|
@@ -656,18 +656,6 @@ module Orb
|
|
656
656
|
|
657
657
|
# @!method self.variants
|
658
658
|
# @return [Array(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Maximum)]
|
659
|
-
|
660
|
-
define_sorbet_constant!(:Variants) do
|
661
|
-
T.type_alias do
|
662
|
-
T.any(
|
663
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
664
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
665
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
666
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Minimum,
|
667
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::AdjustmentInterval::Adjustment::Maximum
|
668
|
-
)
|
669
|
-
end
|
670
|
-
end
|
671
659
|
end
|
672
660
|
end
|
673
661
|
|
@@ -883,16 +871,6 @@ module Orb
|
|
883
871
|
|
884
872
|
# @!method self.variants
|
885
873
|
# @return [Array(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Usage)]
|
886
|
-
|
887
|
-
define_sorbet_constant!(:Variants) do
|
888
|
-
T.type_alias do
|
889
|
-
T.any(
|
890
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Amount,
|
891
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Percentage,
|
892
|
-
Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::DiscountInterval::Usage
|
893
|
-
)
|
894
|
-
end
|
895
|
-
end
|
896
874
|
end
|
897
875
|
|
898
876
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1094,7 +1072,7 @@ module Orb
|
|
1094
1072
|
# For more on the types of prices, see
|
1095
1073
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1096
1074
|
#
|
1097
|
-
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1075
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1098
1076
|
required :price, union: -> { Orb::Price }
|
1099
1077
|
|
1100
1078
|
# @!attribute start_date
|
@@ -1134,7 +1112,7 @@ module Orb
|
|
1134
1112
|
#
|
1135
1113
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1136
1114
|
#
|
1137
|
-
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1115
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1138
1116
|
#
|
1139
1117
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1140
1118
|
#
|
@@ -1214,25 +1192,25 @@ module Orb
|
|
1214
1192
|
# @!attribute created_credit_notes
|
1215
1193
|
# The credit notes that were created as part of this operation.
|
1216
1194
|
#
|
1217
|
-
# @return [Array<Orb::CreditNote>]
|
1195
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1218
1196
|
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1219
1197
|
|
1220
1198
|
# @!attribute created_invoices
|
1221
1199
|
# The invoices that were created as part of this operation.
|
1222
1200
|
#
|
1223
|
-
# @return [Array<Orb::Invoice>]
|
1201
|
+
# @return [Array<Orb::Models::Invoice>]
|
1224
1202
|
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1225
1203
|
|
1226
1204
|
# @!attribute voided_credit_notes
|
1227
1205
|
# The credit notes that were voided as part of this operation.
|
1228
1206
|
#
|
1229
|
-
# @return [Array<Orb::CreditNote>]
|
1207
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1230
1208
|
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1231
1209
|
|
1232
1210
|
# @!attribute voided_invoices
|
1233
1211
|
# The invoices that were voided as part of this operation.
|
1234
1212
|
#
|
1235
|
-
# @return [Array<Orb::Invoice>]
|
1213
|
+
# @return [Array<Orb::Models::Invoice>]
|
1236
1214
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1237
1215
|
|
1238
1216
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
@@ -1240,13 +1218,13 @@ module Orb
|
|
1240
1218
|
# fetched through the subscription changes API or if the
|
1241
1219
|
# `include_changed_resources` parameter was passed in the request.
|
1242
1220
|
#
|
1243
|
-
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1221
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1244
1222
|
#
|
1245
|
-
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1223
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1246
1224
|
#
|
1247
|
-
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1225
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1248
1226
|
#
|
1249
|
-
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1227
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1250
1228
|
end
|
1251
1229
|
end
|
1252
1230
|
end
|
@@ -11,7 +11,7 @@ module Orb
|
|
11
11
|
# The new date that the trial should end, or the literal string `immediate` to end
|
12
12
|
# the trial immediately.
|
13
13
|
#
|
14
|
-
# @return [Time, Symbol, Orb::SubscriptionUpdateTrialParams::TrialEndDate]
|
14
|
+
# @return [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate]
|
15
15
|
required :trial_end_date, union: -> { Orb::SubscriptionUpdateTrialParams::TrialEndDate }
|
16
16
|
|
17
17
|
# @!attribute shift
|
@@ -25,7 +25,7 @@ module Orb
|
|
25
25
|
# Some parameter documentations has been truncated, see
|
26
26
|
# {Orb::Models::SubscriptionUpdateTrialParams} for more details.
|
27
27
|
#
|
28
|
-
# @param trial_end_date [Time, Symbol, Orb::SubscriptionUpdateTrialParams::TrialEndDate] The new date that the trial should end, or the literal string `immediate` to end
|
28
|
+
# @param trial_end_date [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] The new date that the trial should end, or the literal string `immediate` to end
|
29
29
|
#
|
30
30
|
# @param shift [Boolean] If true, shifts subsequent price and adjustment intervals (preserving their dura
|
31
31
|
#
|
@@ -38,7 +38,7 @@ module Orb
|
|
38
38
|
|
39
39
|
variant Time
|
40
40
|
|
41
|
-
variant const: -> { Orb::SubscriptionUpdateTrialParams::TrialEndDate::IMMEDIATE }
|
41
|
+
variant const: -> { Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::IMMEDIATE }
|
42
42
|
|
43
43
|
# @!method self.variants
|
44
44
|
# @return [Array(Time, Symbol)]
|
@@ -88,7 +88,7 @@ module Orb
|
|
88
88
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
89
89
|
# information on what this timezone parameter influences within Orb.
|
90
90
|
#
|
91
|
-
# @return [Orb::Customer]
|
91
|
+
# @return [Orb::Models::Customer]
|
92
92
|
required :customer, -> { Orb::Customer }
|
93
93
|
|
94
94
|
# @!attribute default_invoice_memo
|
@@ -168,7 +168,7 @@ module Orb
|
|
168
168
|
# subscription. You can see more about how to configure prices in the
|
169
169
|
# [Price resource](/reference/price).
|
170
170
|
#
|
171
|
-
# @return [Orb::Plan]
|
171
|
+
# @return [Orb::Models::Plan]
|
172
172
|
required :plan, -> { Orb::Plan }
|
173
173
|
|
174
174
|
# @!attribute price_intervals
|
@@ -231,7 +231,7 @@ module Orb
|
|
231
231
|
#
|
232
232
|
# @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
|
233
233
|
#
|
234
|
-
# @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
234
|
+
# @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
|
235
235
|
#
|
236
236
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
237
237
|
#
|
@@ -253,7 +253,7 @@ module Orb
|
|
253
253
|
#
|
254
254
|
# @param pending_subscription_change [Orb::Models::SubscriptionUpdateTrialResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
|
255
255
|
#
|
256
|
-
# @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
256
|
+
# @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
257
257
|
#
|
258
258
|
# @param price_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval>] The price intervals for this subscription.
|
259
259
|
#
|
@@ -654,18 +654,6 @@ module Orb
|
|
654
654
|
|
655
655
|
# @!method self.variants
|
656
656
|
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum)]
|
657
|
-
|
658
|
-
define_sorbet_constant!(:Variants) do
|
659
|
-
T.type_alias do
|
660
|
-
T.any(
|
661
|
-
Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
662
|
-
Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
663
|
-
Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
664
|
-
Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum,
|
665
|
-
Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum
|
666
|
-
)
|
667
|
-
end
|
668
|
-
end
|
669
657
|
end
|
670
658
|
end
|
671
659
|
|
@@ -880,16 +868,6 @@ module Orb
|
|
880
868
|
|
881
869
|
# @!method self.variants
|
882
870
|
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage)]
|
883
|
-
|
884
|
-
define_sorbet_constant!(:Variants) do
|
885
|
-
T.type_alias do
|
886
|
-
T.any(
|
887
|
-
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount,
|
888
|
-
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage,
|
889
|
-
Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage
|
890
|
-
)
|
891
|
-
end
|
892
|
-
end
|
893
871
|
end
|
894
872
|
|
895
873
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1091,7 +1069,7 @@ module Orb
|
|
1091
1069
|
# For more on the types of prices, see
|
1092
1070
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1093
1071
|
#
|
1094
|
-
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
|
1072
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
|
1095
1073
|
required :price, union: -> { Orb::Price }
|
1096
1074
|
|
1097
1075
|
# @!attribute start_date
|
@@ -1130,7 +1108,7 @@ module Orb
|
|
1130
1108
|
#
|
1131
1109
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1132
1110
|
#
|
1133
|
-
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1111
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
|
1134
1112
|
#
|
1135
1113
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
1136
1114
|
#
|
@@ -1210,25 +1188,25 @@ module Orb
|
|
1210
1188
|
# @!attribute created_credit_notes
|
1211
1189
|
# The credit notes that were created as part of this operation.
|
1212
1190
|
#
|
1213
|
-
# @return [Array<Orb::CreditNote>]
|
1191
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1214
1192
|
required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1215
1193
|
|
1216
1194
|
# @!attribute created_invoices
|
1217
1195
|
# The invoices that were created as part of this operation.
|
1218
1196
|
#
|
1219
|
-
# @return [Array<Orb::Invoice>]
|
1197
|
+
# @return [Array<Orb::Models::Invoice>]
|
1220
1198
|
required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1221
1199
|
|
1222
1200
|
# @!attribute voided_credit_notes
|
1223
1201
|
# The credit notes that were voided as part of this operation.
|
1224
1202
|
#
|
1225
|
-
# @return [Array<Orb::CreditNote>]
|
1203
|
+
# @return [Array<Orb::Models::CreditNote>]
|
1226
1204
|
required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
|
1227
1205
|
|
1228
1206
|
# @!attribute voided_invoices
|
1229
1207
|
# The invoices that were voided as part of this operation.
|
1230
1208
|
#
|
1231
|
-
# @return [Array<Orb::Invoice>]
|
1209
|
+
# @return [Array<Orb::Models::Invoice>]
|
1232
1210
|
required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
|
1233
1211
|
|
1234
1212
|
# @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
|
@@ -1236,13 +1214,13 @@ module Orb
|
|
1236
1214
|
# fetched through the subscription changes API or if the
|
1237
1215
|
# `include_changed_resources` parameter was passed in the request.
|
1238
1216
|
#
|
1239
|
-
# @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
|
1217
|
+
# @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
|
1240
1218
|
#
|
1241
|
-
# @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
|
1219
|
+
# @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
|
1242
1220
|
#
|
1243
|
-
# @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
|
1221
|
+
# @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
|
1244
1222
|
#
|
1245
|
-
# @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
|
1223
|
+
# @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
|
1246
1224
|
end
|
1247
1225
|
end
|
1248
1226
|
end
|
@@ -13,17 +13,17 @@ module Orb
|
|
13
13
|
class UngroupedSubscriptionUsage < Orb::Internal::Type::BaseModel
|
14
14
|
# @!attribute data
|
15
15
|
#
|
16
|
-
# @return [Array<Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
|
16
|
+
# @return [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
|
17
17
|
required :data,
|
18
18
|
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data] }
|
19
19
|
|
20
20
|
# @!method initialize(data:)
|
21
|
-
# @param data [Array<Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
|
21
|
+
# @param data [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data>]
|
22
22
|
|
23
23
|
class Data < Orb::Internal::Type::BaseModel
|
24
24
|
# @!attribute billable_metric
|
25
25
|
#
|
26
|
-
# @return [Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
|
26
|
+
# @return [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
|
27
27
|
required :billable_metric,
|
28
28
|
-> {
|
29
29
|
Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric
|
@@ -31,7 +31,7 @@ module Orb
|
|
31
31
|
|
32
32
|
# @!attribute usage
|
33
33
|
#
|
34
|
-
# @return [Array<Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
|
34
|
+
# @return [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
|
35
35
|
required :usage,
|
36
36
|
-> {
|
37
37
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage]
|
@@ -39,15 +39,15 @@ module Orb
|
|
39
39
|
|
40
40
|
# @!attribute view_mode
|
41
41
|
#
|
42
|
-
# @return [Symbol, Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
|
42
|
+
# @return [Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
|
43
43
|
required :view_mode, enum: -> { Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode }
|
44
44
|
|
45
45
|
# @!method initialize(billable_metric:, usage:, view_mode:)
|
46
|
-
# @param billable_metric [Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
|
47
|
-
# @param usage [Array<Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
|
48
|
-
# @param view_mode [Symbol, Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
|
46
|
+
# @param billable_metric [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric]
|
47
|
+
# @param usage [Array<Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage>]
|
48
|
+
# @param view_mode [Symbol, Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::ViewMode]
|
49
49
|
|
50
|
-
# @see Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data#billable_metric
|
50
|
+
# @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#billable_metric
|
51
51
|
class BillableMetric < Orb::Internal::Type::BaseModel
|
52
52
|
# @!attribute id
|
53
53
|
#
|
@@ -86,7 +86,7 @@ module Orb
|
|
86
86
|
# @param timeframe_start [Time]
|
87
87
|
end
|
88
88
|
|
89
|
-
# @see Orb::SubscriptionUsage::UngroupedSubscriptionUsage::Data#view_mode
|
89
|
+
# @see Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data#view_mode
|
90
90
|
module ViewMode
|
91
91
|
extend Orb::Internal::Type::Enum
|
92
92
|
|
@@ -102,23 +102,23 @@ module Orb
|
|
102
102
|
class GroupedSubscriptionUsage < Orb::Internal::Type::BaseModel
|
103
103
|
# @!attribute data
|
104
104
|
#
|
105
|
-
# @return [Array<Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
|
105
|
+
# @return [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
|
106
106
|
required :data,
|
107
107
|
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data] }
|
108
108
|
|
109
109
|
# @!attribute pagination_metadata
|
110
110
|
#
|
111
|
-
# @return [Orb::PaginationMetadata, nil]
|
111
|
+
# @return [Orb::Models::PaginationMetadata, nil]
|
112
112
|
optional :pagination_metadata, -> { Orb::PaginationMetadata }, nil?: true
|
113
113
|
|
114
114
|
# @!method initialize(data:, pagination_metadata: nil)
|
115
|
-
# @param data [Array<Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
|
116
|
-
# @param pagination_metadata [Orb::PaginationMetadata, nil]
|
115
|
+
# @param data [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data>]
|
116
|
+
# @param pagination_metadata [Orb::Models::PaginationMetadata, nil]
|
117
117
|
|
118
118
|
class Data < Orb::Internal::Type::BaseModel
|
119
119
|
# @!attribute billable_metric
|
120
120
|
#
|
121
|
-
# @return [Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
|
121
|
+
# @return [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
|
122
122
|
required :billable_metric,
|
123
123
|
-> {
|
124
124
|
Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric
|
@@ -126,12 +126,12 @@ module Orb
|
|
126
126
|
|
127
127
|
# @!attribute metric_group
|
128
128
|
#
|
129
|
-
# @return [Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
|
129
|
+
# @return [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
|
130
130
|
required :metric_group, -> { Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup }
|
131
131
|
|
132
132
|
# @!attribute usage
|
133
133
|
#
|
134
|
-
# @return [Array<Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
|
134
|
+
# @return [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
|
135
135
|
required :usage,
|
136
136
|
-> {
|
137
137
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage]
|
@@ -139,16 +139,16 @@ module Orb
|
|
139
139
|
|
140
140
|
# @!attribute view_mode
|
141
141
|
#
|
142
|
-
# @return [Symbol, Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
|
142
|
+
# @return [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
|
143
143
|
required :view_mode, enum: -> { Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode }
|
144
144
|
|
145
145
|
# @!method initialize(billable_metric:, metric_group:, usage:, view_mode:)
|
146
|
-
# @param billable_metric [Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
|
147
|
-
# @param metric_group [Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
|
148
|
-
# @param usage [Array<Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
|
149
|
-
# @param view_mode [Symbol, Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
|
146
|
+
# @param billable_metric [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric]
|
147
|
+
# @param metric_group [Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup]
|
148
|
+
# @param usage [Array<Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage>]
|
149
|
+
# @param view_mode [Symbol, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::ViewMode]
|
150
150
|
|
151
|
-
# @see Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data#billable_metric
|
151
|
+
# @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#billable_metric
|
152
152
|
class BillableMetric < Orb::Internal::Type::BaseModel
|
153
153
|
# @!attribute id
|
154
154
|
#
|
@@ -165,7 +165,7 @@ module Orb
|
|
165
165
|
# @param name [String]
|
166
166
|
end
|
167
167
|
|
168
|
-
# @see Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data#metric_group
|
168
|
+
# @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#metric_group
|
169
169
|
class MetricGroup < Orb::Internal::Type::BaseModel
|
170
170
|
# @!attribute property_key
|
171
171
|
#
|
@@ -204,7 +204,7 @@ module Orb
|
|
204
204
|
# @param timeframe_start [Time]
|
205
205
|
end
|
206
206
|
|
207
|
-
# @see Orb::SubscriptionUsage::GroupedSubscriptionUsage::Data#view_mode
|
207
|
+
# @see Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data#view_mode
|
208
208
|
module ViewMode
|
209
209
|
extend Orb::Internal::Type::Enum
|
210
210
|
|
@@ -218,16 +218,7 @@ module Orb
|
|
218
218
|
end
|
219
219
|
|
220
220
|
# @!method self.variants
|
221
|
-
# @return [Array(Orb::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::SubscriptionUsage::GroupedSubscriptionUsage)]
|
222
|
-
|
223
|
-
define_sorbet_constant!(:Variants) do
|
224
|
-
T.type_alias do
|
225
|
-
T.any(
|
226
|
-
Orb::SubscriptionUsage::UngroupedSubscriptionUsage,
|
227
|
-
Orb::SubscriptionUsage::GroupedSubscriptionUsage
|
228
|
-
)
|
229
|
-
end
|
230
|
-
end
|
221
|
+
# @return [Array(Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage)]
|
231
222
|
end
|
232
223
|
end
|
233
224
|
end
|