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
@@ -32,6 +32,15 @@ module Orb
|
|
32
32
|
?cancelled_at: Time?
|
33
33
|
) -> void
|
34
34
|
|
35
|
+
def to_hash: -> {
|
36
|
+
id: String,
|
37
|
+
expiration_time: Time,
|
38
|
+
status: Orb::Models::SubscriptionChangeRetrieveResponse::status,
|
39
|
+
subscription: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription?,
|
40
|
+
applied_at: Time?,
|
41
|
+
cancelled_at: Time?
|
42
|
+
}
|
43
|
+
|
35
44
|
type status = :pending | :applied | :cancelled
|
36
45
|
|
37
46
|
module Status
|
@@ -160,6 +169,36 @@ module Orb
|
|
160
169
|
?changed_resources: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources?
|
161
170
|
) -> void
|
162
171
|
|
172
|
+
def to_hash: -> {
|
173
|
+
id: String,
|
174
|
+
active_plan_phase_order: Integer?,
|
175
|
+
adjustment_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval],
|
176
|
+
auto_collection: bool?,
|
177
|
+
billing_cycle_anchor_configuration: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration,
|
178
|
+
billing_cycle_day: Integer,
|
179
|
+
created_at: Time,
|
180
|
+
current_billing_period_end_date: Time?,
|
181
|
+
current_billing_period_start_date: Time?,
|
182
|
+
customer: Orb::Customer,
|
183
|
+
default_invoice_memo: String?,
|
184
|
+
discount_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::discount_interval],
|
185
|
+
end_date: Time?,
|
186
|
+
fixed_fee_quantity_schedule: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule],
|
187
|
+
invoicing_threshold: String?,
|
188
|
+
maximum_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval],
|
189
|
+
metadata: ::Hash[Symbol, String],
|
190
|
+
minimum_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval],
|
191
|
+
net_terms: Integer,
|
192
|
+
pending_subscription_change: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange?,
|
193
|
+
plan: Orb::Plan,
|
194
|
+
price_intervals: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval],
|
195
|
+
redeemed_coupon: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon?,
|
196
|
+
start_date: Time,
|
197
|
+
status: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::status,
|
198
|
+
trial_info: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo,
|
199
|
+
changed_resources: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources?
|
200
|
+
}
|
201
|
+
|
163
202
|
type adjustment_interval =
|
164
203
|
{
|
165
204
|
id: String,
|
@@ -188,6 +227,14 @@ module Orb
|
|
188
227
|
start_date: Time
|
189
228
|
) -> void
|
190
229
|
|
230
|
+
def to_hash: -> {
|
231
|
+
id: String,
|
232
|
+
adjustment: Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::adjustment,
|
233
|
+
applies_to_price_interval_ids: ::Array[String],
|
234
|
+
end_date: Time?,
|
235
|
+
start_date: Time
|
236
|
+
}
|
237
|
+
|
191
238
|
type adjustment =
|
192
239
|
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount
|
193
240
|
| Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount
|
@@ -233,6 +280,16 @@ module Orb
|
|
233
280
|
usage_discount: Float,
|
234
281
|
?adjustment_type: :usage_discount
|
235
282
|
) -> void
|
283
|
+
|
284
|
+
def to_hash: -> {
|
285
|
+
id: String,
|
286
|
+
adjustment_type: :usage_discount,
|
287
|
+
applies_to_price_ids: ::Array[String],
|
288
|
+
is_invoice_level: bool,
|
289
|
+
plan_phase_order: Integer?,
|
290
|
+
reason: String?,
|
291
|
+
usage_discount: Float
|
292
|
+
}
|
236
293
|
end
|
237
294
|
|
238
295
|
type amount_discount =
|
@@ -270,6 +327,16 @@ module Orb
|
|
270
327
|
reason: String?,
|
271
328
|
?adjustment_type: :amount_discount
|
272
329
|
) -> void
|
330
|
+
|
331
|
+
def to_hash: -> {
|
332
|
+
id: String,
|
333
|
+
adjustment_type: :amount_discount,
|
334
|
+
amount_discount: String,
|
335
|
+
applies_to_price_ids: ::Array[String],
|
336
|
+
is_invoice_level: bool,
|
337
|
+
plan_phase_order: Integer?,
|
338
|
+
reason: String?
|
339
|
+
}
|
273
340
|
end
|
274
341
|
|
275
342
|
type percentage_discount =
|
@@ -307,6 +374,16 @@ module Orb
|
|
307
374
|
reason: String?,
|
308
375
|
?adjustment_type: :percentage_discount
|
309
376
|
) -> void
|
377
|
+
|
378
|
+
def to_hash: -> {
|
379
|
+
id: String,
|
380
|
+
adjustment_type: :percentage_discount,
|
381
|
+
applies_to_price_ids: ::Array[String],
|
382
|
+
is_invoice_level: bool,
|
383
|
+
percentage_discount: Float,
|
384
|
+
plan_phase_order: Integer?,
|
385
|
+
reason: String?
|
386
|
+
}
|
310
387
|
end
|
311
388
|
|
312
389
|
type minimum =
|
@@ -348,6 +425,17 @@ module Orb
|
|
348
425
|
reason: String?,
|
349
426
|
?adjustment_type: :minimum
|
350
427
|
) -> void
|
428
|
+
|
429
|
+
def to_hash: -> {
|
430
|
+
id: String,
|
431
|
+
adjustment_type: :minimum,
|
432
|
+
applies_to_price_ids: ::Array[String],
|
433
|
+
is_invoice_level: bool,
|
434
|
+
item_id: String,
|
435
|
+
minimum_amount: String,
|
436
|
+
plan_phase_order: Integer?,
|
437
|
+
reason: String?
|
438
|
+
}
|
351
439
|
end
|
352
440
|
|
353
441
|
type maximum =
|
@@ -385,6 +473,16 @@ module Orb
|
|
385
473
|
reason: String?,
|
386
474
|
?adjustment_type: :maximum
|
387
475
|
) -> void
|
476
|
+
|
477
|
+
def to_hash: -> {
|
478
|
+
id: String,
|
479
|
+
adjustment_type: :maximum,
|
480
|
+
applies_to_price_ids: ::Array[String],
|
481
|
+
is_invoice_level: bool,
|
482
|
+
maximum_amount: String,
|
483
|
+
plan_phase_order: Integer?,
|
484
|
+
reason: String?
|
485
|
+
}
|
388
486
|
end
|
389
487
|
|
390
488
|
def self?.variants: -> ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::adjustment]
|
@@ -406,6 +504,8 @@ module Orb
|
|
406
504
|
?month: Integer?,
|
407
505
|
?year: Integer?
|
408
506
|
) -> void
|
507
|
+
|
508
|
+
def to_hash: -> { day: Integer, month: Integer?, year: Integer? }
|
409
509
|
end
|
410
510
|
|
411
511
|
type discount_interval =
|
@@ -447,6 +547,15 @@ module Orb
|
|
447
547
|
start_date: Time,
|
448
548
|
?discount_type: :amount
|
449
549
|
) -> void
|
550
|
+
|
551
|
+
def to_hash: -> {
|
552
|
+
amount_discount: String,
|
553
|
+
applies_to_price_ids: ::Array[String],
|
554
|
+
applies_to_price_interval_ids: ::Array[String],
|
555
|
+
discount_type: :amount,
|
556
|
+
end_date: Time?,
|
557
|
+
start_date: Time
|
558
|
+
}
|
450
559
|
end
|
451
560
|
|
452
561
|
type percentage =
|
@@ -480,6 +589,15 @@ module Orb
|
|
480
589
|
start_date: Time,
|
481
590
|
?discount_type: :percentage
|
482
591
|
) -> void
|
592
|
+
|
593
|
+
def to_hash: -> {
|
594
|
+
applies_to_price_ids: ::Array[String],
|
595
|
+
applies_to_price_interval_ids: ::Array[String],
|
596
|
+
discount_type: :percentage,
|
597
|
+
end_date: Time?,
|
598
|
+
percentage_discount: Float,
|
599
|
+
start_date: Time
|
600
|
+
}
|
483
601
|
end
|
484
602
|
|
485
603
|
type usage =
|
@@ -513,6 +631,15 @@ module Orb
|
|
513
631
|
usage_discount: Float,
|
514
632
|
?discount_type: :usage
|
515
633
|
) -> void
|
634
|
+
|
635
|
+
def to_hash: -> {
|
636
|
+
applies_to_price_ids: ::Array[String],
|
637
|
+
applies_to_price_interval_ids: ::Array[String],
|
638
|
+
discount_type: :usage,
|
639
|
+
end_date: Time?,
|
640
|
+
start_date: Time,
|
641
|
+
usage_discount: Float
|
642
|
+
}
|
516
643
|
end
|
517
644
|
|
518
645
|
def self?.variants: -> ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::discount_interval]
|
@@ -541,6 +668,13 @@ module Orb
|
|
541
668
|
quantity: Float,
|
542
669
|
start_date: Time
|
543
670
|
) -> void
|
671
|
+
|
672
|
+
def to_hash: -> {
|
673
|
+
end_date: Time?,
|
674
|
+
price_id: String,
|
675
|
+
quantity: Float,
|
676
|
+
start_date: Time
|
677
|
+
}
|
544
678
|
end
|
545
679
|
|
546
680
|
type maximum_interval =
|
@@ -570,6 +704,14 @@ module Orb
|
|
570
704
|
maximum_amount: String,
|
571
705
|
start_date: Time
|
572
706
|
) -> void
|
707
|
+
|
708
|
+
def to_hash: -> {
|
709
|
+
applies_to_price_ids: ::Array[String],
|
710
|
+
applies_to_price_interval_ids: ::Array[String],
|
711
|
+
end_date: Time?,
|
712
|
+
maximum_amount: String,
|
713
|
+
start_date: Time
|
714
|
+
}
|
573
715
|
end
|
574
716
|
|
575
717
|
type minimum_interval =
|
@@ -599,6 +741,14 @@ module Orb
|
|
599
741
|
minimum_amount: String,
|
600
742
|
start_date: Time
|
601
743
|
) -> void
|
744
|
+
|
745
|
+
def to_hash: -> {
|
746
|
+
applies_to_price_ids: ::Array[String],
|
747
|
+
applies_to_price_interval_ids: ::Array[String],
|
748
|
+
end_date: Time?,
|
749
|
+
minimum_amount: String,
|
750
|
+
start_date: Time
|
751
|
+
}
|
602
752
|
end
|
603
753
|
|
604
754
|
type pending_subscription_change = { id: String }
|
@@ -607,6 +757,8 @@ module Orb
|
|
607
757
|
attr_accessor id: String
|
608
758
|
|
609
759
|
def initialize: (id: String) -> void
|
760
|
+
|
761
|
+
def to_hash: -> { id: String }
|
610
762
|
end
|
611
763
|
|
612
764
|
type price_interval =
|
@@ -657,6 +809,19 @@ module Orb
|
|
657
809
|
usage_customer_ids: ::Array[String]?
|
658
810
|
) -> void
|
659
811
|
|
812
|
+
def to_hash: -> {
|
813
|
+
id: String,
|
814
|
+
billing_cycle_day: Integer,
|
815
|
+
current_billing_period_end_date: Time?,
|
816
|
+
current_billing_period_start_date: Time?,
|
817
|
+
end_date: Time?,
|
818
|
+
filter: String?,
|
819
|
+
fixed_fee_quantity_transitions: ::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]?,
|
820
|
+
price: Orb::Models::price,
|
821
|
+
start_date: Time,
|
822
|
+
usage_customer_ids: ::Array[String]?
|
823
|
+
}
|
824
|
+
|
660
825
|
type fixed_fee_quantity_transition =
|
661
826
|
{ effective_date: Time, price_id: String, quantity: Integer }
|
662
827
|
|
@@ -672,6 +837,12 @@ module Orb
|
|
672
837
|
price_id: String,
|
673
838
|
quantity: Integer
|
674
839
|
) -> void
|
840
|
+
|
841
|
+
def to_hash: -> {
|
842
|
+
effective_date: Time,
|
843
|
+
price_id: String,
|
844
|
+
quantity: Integer
|
845
|
+
}
|
675
846
|
end
|
676
847
|
end
|
677
848
|
|
@@ -690,6 +861,12 @@ module Orb
|
|
690
861
|
end_date: Time?,
|
691
862
|
start_date: Time
|
692
863
|
) -> void
|
864
|
+
|
865
|
+
def to_hash: -> {
|
866
|
+
coupon_id: String,
|
867
|
+
end_date: Time?,
|
868
|
+
start_date: Time
|
869
|
+
}
|
693
870
|
end
|
694
871
|
|
695
872
|
type status = :active | :ended | :upcoming
|
@@ -710,6 +887,8 @@ module Orb
|
|
710
887
|
attr_accessor end_date: Time?
|
711
888
|
|
712
889
|
def initialize: (end_date: Time?) -> void
|
890
|
+
|
891
|
+
def to_hash: -> { end_date: Time? }
|
713
892
|
end
|
714
893
|
|
715
894
|
type changed_resources =
|
@@ -735,6 +914,13 @@ module Orb
|
|
735
914
|
voided_credit_notes: ::Array[Orb::CreditNote],
|
736
915
|
voided_invoices: ::Array[Orb::Invoice]
|
737
916
|
) -> void
|
917
|
+
|
918
|
+
def to_hash: -> {
|
919
|
+
created_credit_notes: ::Array[Orb::CreditNote],
|
920
|
+
created_invoices: ::Array[Orb::Invoice],
|
921
|
+
voided_credit_notes: ::Array[Orb::CreditNote],
|
922
|
+
voided_invoices: ::Array[Orb::Invoice]
|
923
|
+
}
|
738
924
|
end
|
739
925
|
end
|
740
926
|
end
|