orb-billing 0.3.1 → 0.3.2
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 +14 -0
- data/README.md +3 -3
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/type/enum.rb +3 -3
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/util.rb +1 -1
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +6 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +41 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
- data/lib/orb/models/customer_update_params.rb +41 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +157 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +78 -103
- data/lib/orb/models/plan_create_params.rb +727 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1671 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +86 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +21 -57
- data/lib/orb/models/subscription_change_apply_response.rb +21 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
- data/lib/orb/models/subscription_create_params.rb +1865 -1815
- data/lib/orb/models/subscription_create_response.rb +21 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +21 -57
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +19 -6
- data/rbi/orb/internal/transport/base_client.rbi +131 -73
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +124 -65
- data/rbi/orb/internal/type/base_page.rbi +11 -7
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +66 -31
- data/rbi/orb/internal/type/enum.rbi +27 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +60 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +210 -89
- data/rbi/orb/models/alert.rbi +107 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/orb/models/alert_disable_params.rbi +17 -6
- data/rbi/orb/models/alert_enable_params.rbi +17 -6
- data/rbi/orb/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
- data/rbi/orb/models/alert_update_params.rbi +25 -14
- data/rbi/orb/models/amount_discount.rbi +28 -19
- data/rbi/orb/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +10 -4
- data/rbi/orb/models/coupon_create_params.rbi +72 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
- data/rbi/orb/models/coupon_list_params.rbi +18 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/orb/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +58 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
- data/rbi/orb/models/credit_note_list_params.rbi +20 -17
- data/rbi/orb/models/customer.rbi +430 -329
- data/rbi/orb/models/customer_create_params.rbi +662 -325
- data/rbi/orb/models/customer_delete_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_params.rbi +10 -4
- data/rbi/orb/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
- data/rbi/orb/models/customer_update_params.rbi +661 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/orb/models/dimensional_price_group.rbi +18 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
- data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +10 -4
- data/rbi/orb/models/event_deprecate_response.rbi +8 -3
- data/rbi/orb/models/event_ingest_params.rbi +37 -31
- data/rbi/orb/models/event_ingest_response.rbi +63 -23
- data/rbi/orb/models/event_search_params.rbi +17 -14
- data/rbi/orb/models/event_search_response.rbi +33 -21
- data/rbi/orb/models/event_update_params.rbi +19 -16
- data/rbi/orb/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/orb/models/events/event_volumes.rbi +32 -10
- data/rbi/orb/models/events/volume_list_params.rbi +18 -15
- data/rbi/orb/models/invoice.rbi +1286 -805
- data/rbi/orb/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
- data/rbi/orb/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
- data/rbi/orb/models/invoice_list_params.rbi +67 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +10 -4
- data/rbi/orb/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +10 -4
- data/rbi/orb/models/item.rbi +87 -39
- data/rbi/orb/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +10 -4
- data/rbi/orb/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +79 -39
- data/rbi/orb/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +10 -4
- data/rbi/orb/models/metric_list_params.rbi +20 -17
- data/rbi/orb/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +16 -4
- data/rbi/orb/models/percentage_discount.rbi +32 -19
- data/rbi/orb/models/plan.rbi +496 -365
- data/rbi/orb/models/plan_create_params.rbi +4785 -2875
- data/rbi/orb/models/plan_fetch_params.rbi +10 -4
- data/rbi/orb/models/plan_list_params.rbi +34 -27
- data/rbi/orb/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +9969 -5024
- data/rbi/orb/models/price_create_params.rbi +501 -245
- data/rbi/orb/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +11 -6
- data/rbi/orb/models/price_fetch_params.rbi +10 -4
- data/rbi/orb/models/price_list_params.rbi +16 -6
- data/rbi/orb/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/orb/models/subscription.rbi +578 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
- data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
- data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
- data/rbi/orb/models/subscription_create_response.rbi +700 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/orb/models/subscription_list_params.rbi +39 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
- data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
- data/rbi/orb/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
- data/rbi/orb/models/subscription_usage.rbi +271 -121
- data/rbi/orb/models/subscriptions.rbi +18 -11
- data/rbi/orb/models/top_level_ping_params.rbi +10 -4
- data/rbi/orb/models/top_level_ping_response.rbi +7 -3
- data/rbi/orb/models/trial_discount.rbi +29 -20
- data/rbi/orb/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -3,6 +3,8 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
7
|
+
|
6
8
|
sig { returns(String) }
|
7
9
|
attr_accessor :id
|
8
10
|
|
@@ -13,7 +15,13 @@ module Orb
|
|
13
15
|
|
14
16
|
# The adjustment intervals for this subscription sorted by the start_date of the
|
15
17
|
# adjustment interval.
|
16
|
-
sig
|
18
|
+
sig do
|
19
|
+
returns(
|
20
|
+
T::Array[
|
21
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval
|
22
|
+
]
|
23
|
+
)
|
24
|
+
end
|
17
25
|
attr_accessor :adjustment_intervals
|
18
26
|
|
19
27
|
# Determines whether issued invoices for this subscription will automatically be
|
@@ -22,17 +30,18 @@ module Orb
|
|
22
30
|
sig { returns(T.nilable(T::Boolean)) }
|
23
31
|
attr_accessor :auto_collection
|
24
32
|
|
25
|
-
sig
|
33
|
+
sig do
|
34
|
+
returns(
|
35
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration
|
36
|
+
)
|
37
|
+
end
|
26
38
|
attr_reader :billing_cycle_anchor_configuration
|
27
39
|
|
28
40
|
sig do
|
29
41
|
params(
|
30
|
-
billing_cycle_anchor_configuration:
|
31
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration
|
32
|
-
|
33
|
-
)
|
34
|
-
)
|
35
|
-
.void
|
42
|
+
billing_cycle_anchor_configuration:
|
43
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration::OrHash
|
44
|
+
).void
|
36
45
|
end
|
37
46
|
attr_writer :billing_cycle_anchor_configuration
|
38
47
|
|
@@ -76,10 +85,10 @@ module Orb
|
|
76
85
|
# [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
77
86
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
78
87
|
# information on what this timezone parameter influences within Orb.
|
79
|
-
sig { returns(Orb::
|
88
|
+
sig { returns(Orb::Customer) }
|
80
89
|
attr_reader :customer
|
81
90
|
|
82
|
-
sig { params(customer:
|
91
|
+
sig { params(customer: Orb::Customer::OrHash).void }
|
83
92
|
attr_writer :customer
|
84
93
|
|
85
94
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
@@ -105,14 +114,26 @@ module Orb
|
|
105
114
|
sig { returns(T.nilable(Time)) }
|
106
115
|
attr_accessor :end_date
|
107
116
|
|
108
|
-
sig
|
117
|
+
sig do
|
118
|
+
returns(
|
119
|
+
T::Array[
|
120
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule
|
121
|
+
]
|
122
|
+
)
|
123
|
+
end
|
109
124
|
attr_accessor :fixed_fee_quantity_schedule
|
110
125
|
|
111
126
|
sig { returns(T.nilable(String)) }
|
112
127
|
attr_accessor :invoicing_threshold
|
113
128
|
|
114
129
|
# The maximum intervals for this subscription sorted by the start_date.
|
115
|
-
sig
|
130
|
+
sig do
|
131
|
+
returns(
|
132
|
+
T::Array[
|
133
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval
|
134
|
+
]
|
135
|
+
)
|
136
|
+
end
|
116
137
|
attr_accessor :maximum_intervals
|
117
138
|
|
118
139
|
# User specified key-value pairs for the resource. If not present, this defaults
|
@@ -123,7 +144,13 @@ module Orb
|
|
123
144
|
attr_accessor :metadata
|
124
145
|
|
125
146
|
# The minimum intervals for this subscription sorted by the start_date.
|
126
|
-
sig
|
147
|
+
sig do
|
148
|
+
returns(
|
149
|
+
T::Array[
|
150
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval
|
151
|
+
]
|
152
|
+
)
|
153
|
+
end
|
127
154
|
attr_accessor :minimum_intervals
|
128
155
|
|
129
156
|
# Determines the difference between the invoice issue date for subscription
|
@@ -134,19 +161,22 @@ module Orb
|
|
134
161
|
attr_accessor :net_terms
|
135
162
|
|
136
163
|
# A pending subscription change if one exists on this subscription.
|
137
|
-
sig
|
164
|
+
sig do
|
165
|
+
returns(
|
166
|
+
T.nilable(
|
167
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
|
168
|
+
)
|
169
|
+
)
|
170
|
+
end
|
138
171
|
attr_reader :pending_subscription_change
|
139
172
|
|
140
173
|
sig do
|
141
174
|
params(
|
142
|
-
pending_subscription_change:
|
143
|
-
T.
|
144
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
|
145
|
-
Orb::Internal::AnyHash
|
175
|
+
pending_subscription_change:
|
176
|
+
T.nilable(
|
177
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange::OrHash
|
146
178
|
)
|
147
|
-
|
148
|
-
)
|
149
|
-
.void
|
179
|
+
).void
|
150
180
|
end
|
151
181
|
attr_writer :pending_subscription_change
|
152
182
|
|
@@ -154,26 +184,38 @@ module Orb
|
|
154
184
|
# subscribed to by a customer. Plans define the billing behavior of the
|
155
185
|
# subscription. You can see more about how to configure prices in the
|
156
186
|
# [Price resource](/reference/price).
|
157
|
-
sig { returns(Orb::
|
187
|
+
sig { returns(Orb::Plan) }
|
158
188
|
attr_reader :plan
|
159
189
|
|
160
|
-
sig { params(plan:
|
190
|
+
sig { params(plan: Orb::Plan::OrHash).void }
|
161
191
|
attr_writer :plan
|
162
192
|
|
163
193
|
# The price intervals for this subscription.
|
164
|
-
sig
|
194
|
+
sig do
|
195
|
+
returns(
|
196
|
+
T::Array[
|
197
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval
|
198
|
+
]
|
199
|
+
)
|
200
|
+
end
|
165
201
|
attr_accessor :price_intervals
|
166
202
|
|
167
|
-
sig
|
203
|
+
sig do
|
204
|
+
returns(
|
205
|
+
T.nilable(
|
206
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon
|
207
|
+
)
|
208
|
+
)
|
209
|
+
end
|
168
210
|
attr_reader :redeemed_coupon
|
169
211
|
|
170
212
|
sig do
|
171
213
|
params(
|
172
|
-
redeemed_coupon:
|
173
|
-
T.
|
174
|
-
|
175
|
-
|
176
|
-
|
214
|
+
redeemed_coupon:
|
215
|
+
T.nilable(
|
216
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon::OrHash
|
217
|
+
)
|
218
|
+
).void
|
177
219
|
end
|
178
220
|
attr_writer :redeemed_coupon
|
179
221
|
|
@@ -181,33 +223,45 @@ module Orb
|
|
181
223
|
sig { returns(Time) }
|
182
224
|
attr_accessor :start_date
|
183
225
|
|
184
|
-
sig
|
226
|
+
sig do
|
227
|
+
returns(
|
228
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
229
|
+
)
|
230
|
+
end
|
185
231
|
attr_accessor :status
|
186
232
|
|
187
|
-
sig
|
233
|
+
sig do
|
234
|
+
returns(Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo)
|
235
|
+
end
|
188
236
|
attr_reader :trial_info
|
189
237
|
|
190
238
|
sig do
|
191
239
|
params(
|
192
|
-
trial_info:
|
193
|
-
|
194
|
-
|
240
|
+
trial_info:
|
241
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo::OrHash
|
242
|
+
).void
|
195
243
|
end
|
196
244
|
attr_writer :trial_info
|
197
245
|
|
198
246
|
# The resources that were changed as part of this operation. Only present when
|
199
247
|
# fetched through the subscription changes API or if the
|
200
248
|
# `include_changed_resources` parameter was passed in the request.
|
201
|
-
sig
|
249
|
+
sig do
|
250
|
+
returns(
|
251
|
+
T.nilable(
|
252
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources
|
253
|
+
)
|
254
|
+
)
|
255
|
+
end
|
202
256
|
attr_reader :changed_resources
|
203
257
|
|
204
258
|
sig do
|
205
259
|
params(
|
206
|
-
changed_resources:
|
207
|
-
T.
|
208
|
-
|
209
|
-
|
210
|
-
|
260
|
+
changed_resources:
|
261
|
+
T.nilable(
|
262
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources::OrHash
|
263
|
+
)
|
264
|
+
).void
|
211
265
|
end
|
212
266
|
attr_writer :changed_resources
|
213
267
|
|
@@ -215,57 +269,66 @@ module Orb
|
|
215
269
|
params(
|
216
270
|
id: String,
|
217
271
|
active_plan_phase_order: T.nilable(Integer),
|
218
|
-
adjustment_intervals:
|
272
|
+
adjustment_intervals:
|
273
|
+
T::Array[
|
274
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::OrHash
|
275
|
+
],
|
219
276
|
auto_collection: T.nilable(T::Boolean),
|
220
|
-
billing_cycle_anchor_configuration:
|
221
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration,
|
222
|
-
Orb::Internal::AnyHash
|
223
|
-
),
|
277
|
+
billing_cycle_anchor_configuration:
|
278
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration::OrHash,
|
224
279
|
billing_cycle_day: Integer,
|
225
280
|
created_at: Time,
|
226
281
|
current_billing_period_end_date: T.nilable(Time),
|
227
282
|
current_billing_period_start_date: T.nilable(Time),
|
228
|
-
customer:
|
283
|
+
customer: Orb::Customer::OrHash,
|
229
284
|
default_invoice_memo: T.nilable(String),
|
230
|
-
discount_intervals:
|
231
|
-
T
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
285
|
+
discount_intervals:
|
286
|
+
T::Array[
|
287
|
+
T.any(
|
288
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::OrHash,
|
289
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::OrHash,
|
290
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::OrHash
|
291
|
+
)
|
292
|
+
],
|
238
293
|
end_date: T.nilable(Time),
|
239
|
-
fixed_fee_quantity_schedule:
|
240
|
-
T
|
241
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule
|
242
|
-
|
243
|
-
)
|
244
|
-
],
|
294
|
+
fixed_fee_quantity_schedule:
|
295
|
+
T::Array[
|
296
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule::OrHash
|
297
|
+
],
|
245
298
|
invoicing_threshold: T.nilable(String),
|
246
|
-
maximum_intervals:
|
299
|
+
maximum_intervals:
|
300
|
+
T::Array[
|
301
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::OrHash
|
302
|
+
],
|
247
303
|
metadata: T::Hash[Symbol, String],
|
248
|
-
minimum_intervals:
|
304
|
+
minimum_intervals:
|
305
|
+
T::Array[
|
306
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::OrHash
|
307
|
+
],
|
249
308
|
net_terms: Integer,
|
250
|
-
pending_subscription_change:
|
251
|
-
T.
|
252
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
309
|
+
pending_subscription_change:
|
310
|
+
T.nilable(
|
311
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange::OrHash
|
312
|
+
),
|
313
|
+
plan: Orb::Plan::OrHash,
|
314
|
+
price_intervals:
|
315
|
+
T::Array[
|
316
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::OrHash
|
317
|
+
],
|
318
|
+
redeemed_coupon:
|
319
|
+
T.nilable(
|
320
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon::OrHash
|
321
|
+
),
|
261
322
|
start_date: Time,
|
262
|
-
status:
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
323
|
+
status:
|
324
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::OrSymbol,
|
325
|
+
trial_info:
|
326
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo::OrHash,
|
327
|
+
changed_resources:
|
328
|
+
T.nilable(
|
329
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources::OrHash
|
330
|
+
)
|
331
|
+
).returns(T.attached_class)
|
269
332
|
end
|
270
333
|
def self.new(
|
271
334
|
id:,
|
@@ -354,50 +417,82 @@ module Orb
|
|
354
417
|
# fetched through the subscription changes API or if the
|
355
418
|
# `include_changed_resources` parameter was passed in the request.
|
356
419
|
changed_resources: nil
|
357
|
-
)
|
420
|
+
)
|
421
|
+
end
|
422
|
+
|
358
423
|
sig do
|
359
|
-
override
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
424
|
+
override.returns(
|
425
|
+
{
|
426
|
+
id: String,
|
427
|
+
active_plan_phase_order: T.nilable(Integer),
|
428
|
+
adjustment_intervals:
|
429
|
+
T::Array[
|
430
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval
|
431
|
+
],
|
432
|
+
auto_collection: T.nilable(T::Boolean),
|
433
|
+
billing_cycle_anchor_configuration:
|
434
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration,
|
435
|
+
billing_cycle_day: Integer,
|
436
|
+
created_at: Time,
|
437
|
+
current_billing_period_end_date: T.nilable(Time),
|
438
|
+
current_billing_period_start_date: T.nilable(Time),
|
439
|
+
customer: Orb::Customer,
|
440
|
+
default_invoice_memo: T.nilable(String),
|
441
|
+
discount_intervals:
|
442
|
+
T::Array[
|
374
443
|
T.any(
|
375
444
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount,
|
376
445
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage,
|
377
446
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage
|
378
447
|
)
|
379
448
|
],
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
449
|
+
end_date: T.nilable(Time),
|
450
|
+
fixed_fee_quantity_schedule:
|
451
|
+
T::Array[
|
452
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule
|
453
|
+
],
|
454
|
+
invoicing_threshold: T.nilable(String),
|
455
|
+
maximum_intervals:
|
456
|
+
T::Array[
|
457
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval
|
458
|
+
],
|
459
|
+
metadata: T::Hash[Symbol, String],
|
460
|
+
minimum_intervals:
|
461
|
+
T::Array[
|
462
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval
|
463
|
+
],
|
464
|
+
net_terms: Integer,
|
465
|
+
pending_subscription_change:
|
466
|
+
T.nilable(
|
467
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
|
468
|
+
),
|
469
|
+
plan: Orb::Plan,
|
470
|
+
price_intervals:
|
471
|
+
T::Array[
|
472
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval
|
473
|
+
],
|
474
|
+
redeemed_coupon:
|
475
|
+
T.nilable(
|
476
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon
|
477
|
+
),
|
478
|
+
start_date: Time,
|
479
|
+
status:
|
480
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol,
|
481
|
+
trial_info:
|
482
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo,
|
483
|
+
changed_resources:
|
484
|
+
T.nilable(
|
485
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources
|
486
|
+
)
|
487
|
+
}
|
488
|
+
)
|
489
|
+
end
|
490
|
+
def to_hash
|
397
491
|
end
|
398
|
-
def to_hash; end
|
399
492
|
|
400
493
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
494
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
495
|
+
|
401
496
|
sig { returns(String) }
|
402
497
|
attr_accessor :id
|
403
498
|
|
@@ -429,19 +524,18 @@ module Orb
|
|
429
524
|
sig do
|
430
525
|
params(
|
431
526
|
id: String,
|
432
|
-
adjustment:
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
527
|
+
adjustment:
|
528
|
+
T.any(
|
529
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::OrHash,
|
530
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::OrHash,
|
531
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::OrHash,
|
532
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::OrHash,
|
533
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::OrHash
|
534
|
+
),
|
440
535
|
applies_to_price_interval_ids: T::Array[String],
|
441
536
|
end_date: T.nilable(Time),
|
442
537
|
start_date: Time
|
443
|
-
)
|
444
|
-
.returns(T.attached_class)
|
538
|
+
).returns(T.attached_class)
|
445
539
|
end
|
446
540
|
def self.new(
|
447
541
|
id:,
|
@@ -452,31 +546,47 @@ module Orb
|
|
452
546
|
end_date:,
|
453
547
|
# The start date of the adjustment interval.
|
454
548
|
start_date:
|
455
|
-
)
|
549
|
+
)
|
550
|
+
end
|
551
|
+
|
456
552
|
sig do
|
457
|
-
override
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
553
|
+
override.returns(
|
554
|
+
{
|
555
|
+
id: String,
|
556
|
+
adjustment:
|
557
|
+
T.any(
|
462
558
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
463
559
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
464
560
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
465
561
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum,
|
466
562
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum
|
467
563
|
),
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
564
|
+
applies_to_price_interval_ids: T::Array[String],
|
565
|
+
end_date: T.nilable(Time),
|
566
|
+
start_date: Time
|
567
|
+
}
|
568
|
+
)
|
569
|
+
end
|
570
|
+
def to_hash
|
473
571
|
end
|
474
|
-
def to_hash; end
|
475
572
|
|
476
573
|
module Adjustment
|
477
574
|
extend Orb::Internal::Type::Union
|
478
575
|
|
576
|
+
Variants =
|
577
|
+
T.type_alias do
|
578
|
+
T.any(
|
579
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
580
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
581
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
582
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum,
|
583
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum
|
584
|
+
)
|
585
|
+
end
|
586
|
+
|
479
587
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
588
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
589
|
+
|
480
590
|
sig { returns(String) }
|
481
591
|
attr_accessor :id
|
482
592
|
|
@@ -514,8 +624,7 @@ module Orb
|
|
514
624
|
reason: T.nilable(String),
|
515
625
|
usage_discount: Float,
|
516
626
|
adjustment_type: Symbol
|
517
|
-
)
|
518
|
-
.returns(T.attached_class)
|
627
|
+
).returns(T.attached_class)
|
519
628
|
end
|
520
629
|
def self.new(
|
521
630
|
id:,
|
@@ -532,25 +641,29 @@ module Orb
|
|
532
641
|
# to in a given billing period.
|
533
642
|
usage_discount:,
|
534
643
|
adjustment_type: :usage_discount
|
535
|
-
)
|
644
|
+
)
|
645
|
+
end
|
646
|
+
|
536
647
|
sig do
|
537
|
-
override
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
648
|
+
override.returns(
|
649
|
+
{
|
650
|
+
id: String,
|
651
|
+
adjustment_type: Symbol,
|
652
|
+
applies_to_price_ids: T::Array[String],
|
653
|
+
is_invoice_level: T::Boolean,
|
654
|
+
plan_phase_order: T.nilable(Integer),
|
655
|
+
reason: T.nilable(String),
|
656
|
+
usage_discount: Float
|
657
|
+
}
|
658
|
+
)
|
659
|
+
end
|
660
|
+
def to_hash
|
549
661
|
end
|
550
|
-
def to_hash; end
|
551
662
|
end
|
552
663
|
|
553
664
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
665
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
666
|
+
|
554
667
|
sig { returns(String) }
|
555
668
|
attr_accessor :id
|
556
669
|
|
@@ -588,8 +701,7 @@ module Orb
|
|
588
701
|
plan_phase_order: T.nilable(Integer),
|
589
702
|
reason: T.nilable(String),
|
590
703
|
adjustment_type: Symbol
|
591
|
-
)
|
592
|
-
.returns(T.attached_class)
|
704
|
+
).returns(T.attached_class)
|
593
705
|
end
|
594
706
|
def self.new(
|
595
707
|
id:,
|
@@ -606,25 +718,29 @@ module Orb
|
|
606
718
|
# The reason for the adjustment.
|
607
719
|
reason:,
|
608
720
|
adjustment_type: :amount_discount
|
609
|
-
)
|
721
|
+
)
|
722
|
+
end
|
723
|
+
|
610
724
|
sig do
|
611
|
-
override
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
725
|
+
override.returns(
|
726
|
+
{
|
727
|
+
id: String,
|
728
|
+
adjustment_type: Symbol,
|
729
|
+
amount_discount: String,
|
730
|
+
applies_to_price_ids: T::Array[String],
|
731
|
+
is_invoice_level: T::Boolean,
|
732
|
+
plan_phase_order: T.nilable(Integer),
|
733
|
+
reason: T.nilable(String)
|
734
|
+
}
|
735
|
+
)
|
736
|
+
end
|
737
|
+
def to_hash
|
623
738
|
end
|
624
|
-
def to_hash; end
|
625
739
|
end
|
626
740
|
|
627
741
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
742
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
743
|
+
|
628
744
|
sig { returns(String) }
|
629
745
|
attr_accessor :id
|
630
746
|
|
@@ -662,8 +778,7 @@ module Orb
|
|
662
778
|
plan_phase_order: T.nilable(Integer),
|
663
779
|
reason: T.nilable(String),
|
664
780
|
adjustment_type: Symbol
|
665
|
-
)
|
666
|
-
.returns(T.attached_class)
|
781
|
+
).returns(T.attached_class)
|
667
782
|
end
|
668
783
|
def self.new(
|
669
784
|
id:,
|
@@ -680,25 +795,29 @@ module Orb
|
|
680
795
|
# The reason for the adjustment.
|
681
796
|
reason:,
|
682
797
|
adjustment_type: :percentage_discount
|
683
|
-
)
|
798
|
+
)
|
799
|
+
end
|
800
|
+
|
684
801
|
sig do
|
685
|
-
override
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
802
|
+
override.returns(
|
803
|
+
{
|
804
|
+
id: String,
|
805
|
+
adjustment_type: Symbol,
|
806
|
+
applies_to_price_ids: T::Array[String],
|
807
|
+
is_invoice_level: T::Boolean,
|
808
|
+
percentage_discount: Float,
|
809
|
+
plan_phase_order: T.nilable(Integer),
|
810
|
+
reason: T.nilable(String)
|
811
|
+
}
|
812
|
+
)
|
813
|
+
end
|
814
|
+
def to_hash
|
697
815
|
end
|
698
|
-
def to_hash; end
|
699
816
|
end
|
700
817
|
|
701
818
|
class Minimum < Orb::Internal::Type::BaseModel
|
819
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
820
|
+
|
702
821
|
sig { returns(String) }
|
703
822
|
attr_accessor :id
|
704
823
|
|
@@ -741,8 +860,7 @@ module Orb
|
|
741
860
|
plan_phase_order: T.nilable(Integer),
|
742
861
|
reason: T.nilable(String),
|
743
862
|
adjustment_type: Symbol
|
744
|
-
)
|
745
|
-
.returns(T.attached_class)
|
863
|
+
).returns(T.attached_class)
|
746
864
|
end
|
747
865
|
def self.new(
|
748
866
|
id:,
|
@@ -761,26 +879,30 @@ module Orb
|
|
761
879
|
# The reason for the adjustment.
|
762
880
|
reason:,
|
763
881
|
adjustment_type: :minimum
|
764
|
-
)
|
882
|
+
)
|
883
|
+
end
|
884
|
+
|
765
885
|
sig do
|
766
|
-
override
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
886
|
+
override.returns(
|
887
|
+
{
|
888
|
+
id: String,
|
889
|
+
adjustment_type: Symbol,
|
890
|
+
applies_to_price_ids: T::Array[String],
|
891
|
+
is_invoice_level: T::Boolean,
|
892
|
+
item_id: String,
|
893
|
+
minimum_amount: String,
|
894
|
+
plan_phase_order: T.nilable(Integer),
|
895
|
+
reason: T.nilable(String)
|
896
|
+
}
|
897
|
+
)
|
898
|
+
end
|
899
|
+
def to_hash
|
779
900
|
end
|
780
|
-
def to_hash; end
|
781
901
|
end
|
782
902
|
|
783
903
|
class Maximum < Orb::Internal::Type::BaseModel
|
904
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
905
|
+
|
784
906
|
sig { returns(String) }
|
785
907
|
attr_accessor :id
|
786
908
|
|
@@ -818,8 +940,7 @@ module Orb
|
|
818
940
|
plan_phase_order: T.nilable(Integer),
|
819
941
|
reason: T.nilable(String),
|
820
942
|
adjustment_type: Symbol
|
821
|
-
)
|
822
|
-
.returns(T.attached_class)
|
943
|
+
).returns(T.attached_class)
|
823
944
|
end
|
824
945
|
def self.new(
|
825
946
|
id:,
|
@@ -836,35 +957,41 @@ module Orb
|
|
836
957
|
# The reason for the adjustment.
|
837
958
|
reason:,
|
838
959
|
adjustment_type: :maximum
|
839
|
-
)
|
960
|
+
)
|
961
|
+
end
|
962
|
+
|
840
963
|
sig do
|
841
|
-
override
|
842
|
-
|
843
|
-
|
844
|
-
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
964
|
+
override.returns(
|
965
|
+
{
|
966
|
+
id: String,
|
967
|
+
adjustment_type: Symbol,
|
968
|
+
applies_to_price_ids: T::Array[String],
|
969
|
+
is_invoice_level: T::Boolean,
|
970
|
+
maximum_amount: String,
|
971
|
+
plan_phase_order: T.nilable(Integer),
|
972
|
+
reason: T.nilable(String)
|
973
|
+
}
|
974
|
+
)
|
975
|
+
end
|
976
|
+
def to_hash
|
853
977
|
end
|
854
|
-
def to_hash; end
|
855
978
|
end
|
856
979
|
|
857
980
|
sig do
|
858
|
-
override
|
859
|
-
|
860
|
-
|
861
|
-
|
981
|
+
override.returns(
|
982
|
+
T::Array[
|
983
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Variants
|
984
|
+
]
|
985
|
+
)
|
986
|
+
end
|
987
|
+
def self.variants
|
862
988
|
end
|
863
|
-
def self.variants; end
|
864
989
|
end
|
865
990
|
end
|
866
991
|
|
867
992
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
993
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
994
|
+
|
868
995
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
869
996
|
# number of days in a month is greater than this value, the last day of the month
|
870
997
|
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
@@ -884,7 +1011,11 @@ module Orb
|
|
884
1011
|
attr_accessor :year
|
885
1012
|
|
886
1013
|
sig do
|
887
|
-
params(
|
1014
|
+
params(
|
1015
|
+
day: Integer,
|
1016
|
+
month: T.nilable(Integer),
|
1017
|
+
year: T.nilable(Integer)
|
1018
|
+
).returns(T.attached_class)
|
888
1019
|
end
|
889
1020
|
def self.new(
|
890
1021
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
@@ -899,15 +1030,37 @@ module Orb
|
|
899
1030
|
# The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
900
1031
|
# anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
901
1032
|
year: nil
|
902
|
-
)
|
903
|
-
|
904
|
-
|
1033
|
+
)
|
1034
|
+
end
|
1035
|
+
|
1036
|
+
sig do
|
1037
|
+
override.returns(
|
1038
|
+
{
|
1039
|
+
day: Integer,
|
1040
|
+
month: T.nilable(Integer),
|
1041
|
+
year: T.nilable(Integer)
|
1042
|
+
}
|
1043
|
+
)
|
1044
|
+
end
|
1045
|
+
def to_hash
|
1046
|
+
end
|
905
1047
|
end
|
906
1048
|
|
907
1049
|
module DiscountInterval
|
908
1050
|
extend Orb::Internal::Type::Union
|
909
1051
|
|
1052
|
+
Variants =
|
1053
|
+
T.type_alias do
|
1054
|
+
T.any(
|
1055
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount,
|
1056
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage,
|
1057
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage
|
1058
|
+
)
|
1059
|
+
end
|
1060
|
+
|
910
1061
|
class Amount < Orb::Internal::Type::BaseModel
|
1062
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1063
|
+
|
911
1064
|
# Only available if discount_type is `amount`.
|
912
1065
|
sig { returns(String) }
|
913
1066
|
attr_accessor :amount_discount
|
@@ -939,8 +1092,7 @@ module Orb
|
|
939
1092
|
end_date: T.nilable(Time),
|
940
1093
|
start_date: Time,
|
941
1094
|
discount_type: Symbol
|
942
|
-
)
|
943
|
-
.returns(T.attached_class)
|
1095
|
+
).returns(T.attached_class)
|
944
1096
|
end
|
945
1097
|
def self.new(
|
946
1098
|
# Only available if discount_type is `amount`.
|
@@ -954,24 +1106,28 @@ module Orb
|
|
954
1106
|
# The start date of the discount interval.
|
955
1107
|
start_date:,
|
956
1108
|
discount_type: :amount
|
957
|
-
)
|
1109
|
+
)
|
1110
|
+
end
|
1111
|
+
|
958
1112
|
sig do
|
959
|
-
override
|
960
|
-
|
961
|
-
|
962
|
-
|
963
|
-
|
964
|
-
|
965
|
-
|
966
|
-
|
967
|
-
|
968
|
-
|
969
|
-
|
1113
|
+
override.returns(
|
1114
|
+
{
|
1115
|
+
amount_discount: String,
|
1116
|
+
applies_to_price_ids: T::Array[String],
|
1117
|
+
applies_to_price_interval_ids: T::Array[String],
|
1118
|
+
discount_type: Symbol,
|
1119
|
+
end_date: T.nilable(Time),
|
1120
|
+
start_date: Time
|
1121
|
+
}
|
1122
|
+
)
|
1123
|
+
end
|
1124
|
+
def to_hash
|
970
1125
|
end
|
971
|
-
def to_hash; end
|
972
1126
|
end
|
973
1127
|
|
974
1128
|
class Percentage < Orb::Internal::Type::BaseModel
|
1129
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1130
|
+
|
975
1131
|
# The price ids that this discount interval applies to.
|
976
1132
|
sig { returns(T::Array[String]) }
|
977
1133
|
attr_accessor :applies_to_price_ids
|
@@ -1004,8 +1160,7 @@ module Orb
|
|
1004
1160
|
percentage_discount: Float,
|
1005
1161
|
start_date: Time,
|
1006
1162
|
discount_type: Symbol
|
1007
|
-
)
|
1008
|
-
.returns(T.attached_class)
|
1163
|
+
).returns(T.attached_class)
|
1009
1164
|
end
|
1010
1165
|
def self.new(
|
1011
1166
|
# The price ids that this discount interval applies to.
|
@@ -1020,24 +1175,28 @@ module Orb
|
|
1020
1175
|
# The start date of the discount interval.
|
1021
1176
|
start_date:,
|
1022
1177
|
discount_type: :percentage
|
1023
|
-
)
|
1178
|
+
)
|
1179
|
+
end
|
1180
|
+
|
1024
1181
|
sig do
|
1025
|
-
override
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
|
1031
|
-
|
1032
|
-
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1182
|
+
override.returns(
|
1183
|
+
{
|
1184
|
+
applies_to_price_ids: T::Array[String],
|
1185
|
+
applies_to_price_interval_ids: T::Array[String],
|
1186
|
+
discount_type: Symbol,
|
1187
|
+
end_date: T.nilable(Time),
|
1188
|
+
percentage_discount: Float,
|
1189
|
+
start_date: Time
|
1190
|
+
}
|
1191
|
+
)
|
1192
|
+
end
|
1193
|
+
def to_hash
|
1036
1194
|
end
|
1037
|
-
def to_hash; end
|
1038
1195
|
end
|
1039
1196
|
|
1040
1197
|
class Usage < Orb::Internal::Type::BaseModel
|
1198
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1199
|
+
|
1041
1200
|
# The price ids that this discount interval applies to.
|
1042
1201
|
sig { returns(T::Array[String]) }
|
1043
1202
|
attr_accessor :applies_to_price_ids
|
@@ -1070,8 +1229,7 @@ module Orb
|
|
1070
1229
|
start_date: Time,
|
1071
1230
|
usage_discount: Float,
|
1072
1231
|
discount_type: Symbol
|
1073
|
-
)
|
1074
|
-
.returns(T.attached_class)
|
1232
|
+
).returns(T.attached_class)
|
1075
1233
|
end
|
1076
1234
|
def self.new(
|
1077
1235
|
# The price ids that this discount interval applies to.
|
@@ -1086,33 +1244,39 @@ module Orb
|
|
1086
1244
|
# discount is for
|
1087
1245
|
usage_discount:,
|
1088
1246
|
discount_type: :usage
|
1089
|
-
)
|
1247
|
+
)
|
1248
|
+
end
|
1249
|
+
|
1090
1250
|
sig do
|
1091
|
-
override
|
1092
|
-
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1251
|
+
override.returns(
|
1252
|
+
{
|
1253
|
+
applies_to_price_ids: T::Array[String],
|
1254
|
+
applies_to_price_interval_ids: T::Array[String],
|
1255
|
+
discount_type: Symbol,
|
1256
|
+
end_date: T.nilable(Time),
|
1257
|
+
start_date: Time,
|
1258
|
+
usage_discount: Float
|
1259
|
+
}
|
1260
|
+
)
|
1261
|
+
end
|
1262
|
+
def to_hash
|
1102
1263
|
end
|
1103
|
-
def to_hash; end
|
1104
1264
|
end
|
1105
1265
|
|
1106
1266
|
sig do
|
1107
|
-
override
|
1108
|
-
|
1109
|
-
|
1110
|
-
|
1267
|
+
override.returns(
|
1268
|
+
T::Array[
|
1269
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Variants
|
1270
|
+
]
|
1271
|
+
)
|
1272
|
+
end
|
1273
|
+
def self.variants
|
1111
1274
|
end
|
1112
|
-
def self.variants; end
|
1113
1275
|
end
|
1114
1276
|
|
1115
1277
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
1278
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1279
|
+
|
1116
1280
|
sig { returns(T.nilable(Time)) }
|
1117
1281
|
attr_accessor :end_date
|
1118
1282
|
|
@@ -1126,18 +1290,33 @@ module Orb
|
|
1126
1290
|
attr_accessor :start_date
|
1127
1291
|
|
1128
1292
|
sig do
|
1129
|
-
params(
|
1130
|
-
.
|
1293
|
+
params(
|
1294
|
+
end_date: T.nilable(Time),
|
1295
|
+
price_id: String,
|
1296
|
+
quantity: Float,
|
1297
|
+
start_date: Time
|
1298
|
+
).returns(T.attached_class)
|
1299
|
+
end
|
1300
|
+
def self.new(end_date:, price_id:, quantity:, start_date:)
|
1131
1301
|
end
|
1132
|
-
def self.new(end_date:, price_id:, quantity:, start_date:); end
|
1133
1302
|
|
1134
1303
|
sig do
|
1135
|
-
override.returns(
|
1304
|
+
override.returns(
|
1305
|
+
{
|
1306
|
+
end_date: T.nilable(Time),
|
1307
|
+
price_id: String,
|
1308
|
+
quantity: Float,
|
1309
|
+
start_date: Time
|
1310
|
+
}
|
1311
|
+
)
|
1312
|
+
end
|
1313
|
+
def to_hash
|
1136
1314
|
end
|
1137
|
-
def to_hash; end
|
1138
1315
|
end
|
1139
1316
|
|
1140
1317
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
1318
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1319
|
+
|
1141
1320
|
# The price ids that this maximum interval applies to.
|
1142
1321
|
sig { returns(T::Array[String]) }
|
1143
1322
|
attr_accessor :applies_to_price_ids
|
@@ -1166,8 +1345,7 @@ module Orb
|
|
1166
1345
|
end_date: T.nilable(Time),
|
1167
1346
|
maximum_amount: String,
|
1168
1347
|
start_date: Time
|
1169
|
-
)
|
1170
|
-
.returns(T.attached_class)
|
1348
|
+
).returns(T.attached_class)
|
1171
1349
|
end
|
1172
1350
|
def self.new(
|
1173
1351
|
# The price ids that this maximum interval applies to.
|
@@ -1181,23 +1359,27 @@ module Orb
|
|
1181
1359
|
maximum_amount:,
|
1182
1360
|
# The start date of the maximum interval.
|
1183
1361
|
start_date:
|
1184
|
-
)
|
1362
|
+
)
|
1363
|
+
end
|
1364
|
+
|
1185
1365
|
sig do
|
1186
|
-
override
|
1187
|
-
|
1188
|
-
|
1189
|
-
|
1190
|
-
|
1191
|
-
|
1192
|
-
|
1193
|
-
|
1194
|
-
|
1195
|
-
|
1366
|
+
override.returns(
|
1367
|
+
{
|
1368
|
+
applies_to_price_ids: T::Array[String],
|
1369
|
+
applies_to_price_interval_ids: T::Array[String],
|
1370
|
+
end_date: T.nilable(Time),
|
1371
|
+
maximum_amount: String,
|
1372
|
+
start_date: Time
|
1373
|
+
}
|
1374
|
+
)
|
1375
|
+
end
|
1376
|
+
def to_hash
|
1196
1377
|
end
|
1197
|
-
def to_hash; end
|
1198
1378
|
end
|
1199
1379
|
|
1200
1380
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
1381
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1382
|
+
|
1201
1383
|
# The price ids that this minimum interval applies to.
|
1202
1384
|
sig { returns(T::Array[String]) }
|
1203
1385
|
attr_accessor :applies_to_price_ids
|
@@ -1226,8 +1408,7 @@ module Orb
|
|
1226
1408
|
end_date: T.nilable(Time),
|
1227
1409
|
minimum_amount: String,
|
1228
1410
|
start_date: Time
|
1229
|
-
)
|
1230
|
-
.returns(T.attached_class)
|
1411
|
+
).returns(T.attached_class)
|
1231
1412
|
end
|
1232
1413
|
def self.new(
|
1233
1414
|
# The price ids that this minimum interval applies to.
|
@@ -1241,35 +1422,43 @@ module Orb
|
|
1241
1422
|
minimum_amount:,
|
1242
1423
|
# The start date of the minimum interval.
|
1243
1424
|
start_date:
|
1244
|
-
)
|
1425
|
+
)
|
1426
|
+
end
|
1427
|
+
|
1245
1428
|
sig do
|
1246
|
-
override
|
1247
|
-
|
1248
|
-
|
1249
|
-
|
1250
|
-
|
1251
|
-
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1255
|
-
|
1429
|
+
override.returns(
|
1430
|
+
{
|
1431
|
+
applies_to_price_ids: T::Array[String],
|
1432
|
+
applies_to_price_interval_ids: T::Array[String],
|
1433
|
+
end_date: T.nilable(Time),
|
1434
|
+
minimum_amount: String,
|
1435
|
+
start_date: Time
|
1436
|
+
}
|
1437
|
+
)
|
1438
|
+
end
|
1439
|
+
def to_hash
|
1256
1440
|
end
|
1257
|
-
def to_hash; end
|
1258
1441
|
end
|
1259
1442
|
|
1260
1443
|
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
1444
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1445
|
+
|
1261
1446
|
sig { returns(String) }
|
1262
1447
|
attr_accessor :id
|
1263
1448
|
|
1264
1449
|
# A pending subscription change if one exists on this subscription.
|
1265
1450
|
sig { params(id: String).returns(T.attached_class) }
|
1266
|
-
def self.new(id:)
|
1451
|
+
def self.new(id:)
|
1452
|
+
end
|
1267
1453
|
|
1268
|
-
sig { override.returns({id: String}) }
|
1269
|
-
def to_hash
|
1454
|
+
sig { override.returns({ id: String }) }
|
1455
|
+
def to_hash
|
1456
|
+
end
|
1270
1457
|
end
|
1271
1458
|
|
1272
1459
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
1460
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1461
|
+
|
1273
1462
|
sig { returns(String) }
|
1274
1463
|
attr_accessor :id
|
1275
1464
|
|
@@ -1303,7 +1492,9 @@ module Orb
|
|
1303
1492
|
sig do
|
1304
1493
|
returns(
|
1305
1494
|
T.nilable(
|
1306
|
-
T::Array[
|
1495
|
+
T::Array[
|
1496
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition
|
1497
|
+
]
|
1307
1498
|
)
|
1308
1499
|
)
|
1309
1500
|
end
|
@@ -1322,34 +1513,34 @@ module Orb
|
|
1322
1513
|
sig do
|
1323
1514
|
returns(
|
1324
1515
|
T.any(
|
1325
|
-
Orb::
|
1326
|
-
Orb::
|
1327
|
-
Orb::
|
1328
|
-
Orb::
|
1329
|
-
Orb::
|
1330
|
-
Orb::
|
1331
|
-
Orb::
|
1332
|
-
Orb::
|
1333
|
-
Orb::
|
1334
|
-
Orb::
|
1335
|
-
Orb::
|
1336
|
-
Orb::
|
1337
|
-
Orb::
|
1338
|
-
Orb::
|
1339
|
-
Orb::
|
1340
|
-
Orb::
|
1341
|
-
Orb::
|
1342
|
-
Orb::
|
1343
|
-
Orb::
|
1344
|
-
Orb::
|
1345
|
-
Orb::
|
1346
|
-
Orb::
|
1347
|
-
Orb::
|
1348
|
-
Orb::
|
1349
|
-
Orb::
|
1350
|
-
Orb::
|
1351
|
-
Orb::
|
1352
|
-
Orb::
|
1516
|
+
Orb::Price::Unit,
|
1517
|
+
Orb::Price::Package,
|
1518
|
+
Orb::Price::Matrix,
|
1519
|
+
Orb::Price::Tiered,
|
1520
|
+
Orb::Price::TieredBps,
|
1521
|
+
Orb::Price::Bps,
|
1522
|
+
Orb::Price::BulkBps,
|
1523
|
+
Orb::Price::Bulk,
|
1524
|
+
Orb::Price::ThresholdTotalAmount,
|
1525
|
+
Orb::Price::TieredPackage,
|
1526
|
+
Orb::Price::GroupedTiered,
|
1527
|
+
Orb::Price::TieredWithMinimum,
|
1528
|
+
Orb::Price::TieredPackageWithMinimum,
|
1529
|
+
Orb::Price::PackageWithAllocation,
|
1530
|
+
Orb::Price::UnitWithPercent,
|
1531
|
+
Orb::Price::MatrixWithAllocation,
|
1532
|
+
Orb::Price::TieredWithProration,
|
1533
|
+
Orb::Price::UnitWithProration,
|
1534
|
+
Orb::Price::GroupedAllocation,
|
1535
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1536
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1537
|
+
Orb::Price::MatrixWithDisplayName,
|
1538
|
+
Orb::Price::BulkWithProration,
|
1539
|
+
Orb::Price::GroupedTieredPackage,
|
1540
|
+
Orb::Price::MaxGroupTieredPackage,
|
1541
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1542
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1543
|
+
Orb::Price::CumulativeGroupedBulk
|
1353
1544
|
)
|
1354
1545
|
)
|
1355
1546
|
end
|
@@ -1376,49 +1567,46 @@ module Orb
|
|
1376
1567
|
current_billing_period_start_date: T.nilable(Time),
|
1377
1568
|
end_date: T.nilable(Time),
|
1378
1569
|
filter: T.nilable(String),
|
1379
|
-
fixed_fee_quantity_transitions:
|
1380
|
-
T
|
1381
|
-
T
|
1382
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition
|
1383
|
-
|
1384
|
-
|
1385
|
-
|
1386
|
-
|
1387
|
-
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
|
1392
|
-
|
1393
|
-
|
1394
|
-
|
1395
|
-
|
1396
|
-
|
1397
|
-
|
1398
|
-
|
1399
|
-
|
1400
|
-
|
1401
|
-
|
1402
|
-
|
1403
|
-
|
1404
|
-
|
1405
|
-
|
1406
|
-
|
1407
|
-
|
1408
|
-
|
1409
|
-
|
1410
|
-
|
1411
|
-
|
1412
|
-
|
1413
|
-
|
1414
|
-
|
1415
|
-
|
1416
|
-
Orb::Models::Price::CumulativeGroupedBulk
|
1417
|
-
),
|
1570
|
+
fixed_fee_quantity_transitions:
|
1571
|
+
T.nilable(
|
1572
|
+
T::Array[
|
1573
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition::OrHash
|
1574
|
+
]
|
1575
|
+
),
|
1576
|
+
price:
|
1577
|
+
T.any(
|
1578
|
+
Orb::Price::Unit::OrHash,
|
1579
|
+
Orb::Price::Package::OrHash,
|
1580
|
+
Orb::Price::Matrix::OrHash,
|
1581
|
+
Orb::Price::Tiered::OrHash,
|
1582
|
+
Orb::Price::TieredBps::OrHash,
|
1583
|
+
Orb::Price::Bps::OrHash,
|
1584
|
+
Orb::Price::BulkBps::OrHash,
|
1585
|
+
Orb::Price::Bulk::OrHash,
|
1586
|
+
Orb::Price::ThresholdTotalAmount::OrHash,
|
1587
|
+
Orb::Price::TieredPackage::OrHash,
|
1588
|
+
Orb::Price::GroupedTiered::OrHash,
|
1589
|
+
Orb::Price::TieredWithMinimum::OrHash,
|
1590
|
+
Orb::Price::TieredPackageWithMinimum::OrHash,
|
1591
|
+
Orb::Price::PackageWithAllocation::OrHash,
|
1592
|
+
Orb::Price::UnitWithPercent::OrHash,
|
1593
|
+
Orb::Price::MatrixWithAllocation::OrHash,
|
1594
|
+
Orb::Price::TieredWithProration::OrHash,
|
1595
|
+
Orb::Price::UnitWithProration::OrHash,
|
1596
|
+
Orb::Price::GroupedAllocation::OrHash,
|
1597
|
+
Orb::Price::GroupedWithProratedMinimum::OrHash,
|
1598
|
+
Orb::Price::GroupedWithMeteredMinimum::OrHash,
|
1599
|
+
Orb::Price::MatrixWithDisplayName::OrHash,
|
1600
|
+
Orb::Price::BulkWithProration::OrHash,
|
1601
|
+
Orb::Price::GroupedTieredPackage::OrHash,
|
1602
|
+
Orb::Price::MaxGroupTieredPackage::OrHash,
|
1603
|
+
Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
|
1604
|
+
Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
|
1605
|
+
Orb::Price::CumulativeGroupedBulk::OrHash
|
1606
|
+
),
|
1418
1607
|
start_date: Time,
|
1419
1608
|
usage_customer_ids: T.nilable(T::Array[String])
|
1420
|
-
)
|
1421
|
-
.returns(T.attached_class)
|
1609
|
+
).returns(T.attached_class)
|
1422
1610
|
end
|
1423
1611
|
def self.new(
|
1424
1612
|
id:,
|
@@ -1457,58 +1645,66 @@ module Orb
|
|
1457
1645
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
1458
1646
|
# this price interval.
|
1459
1647
|
usage_customer_ids:
|
1460
|
-
)
|
1648
|
+
)
|
1649
|
+
end
|
1650
|
+
|
1461
1651
|
sig do
|
1462
|
-
override
|
1463
|
-
|
1464
|
-
|
1465
|
-
|
1466
|
-
|
1467
|
-
|
1468
|
-
|
1469
|
-
|
1470
|
-
|
1471
|
-
|
1472
|
-
T::Array[
|
1652
|
+
override.returns(
|
1653
|
+
{
|
1654
|
+
id: String,
|
1655
|
+
billing_cycle_day: Integer,
|
1656
|
+
current_billing_period_end_date: T.nilable(Time),
|
1657
|
+
current_billing_period_start_date: T.nilable(Time),
|
1658
|
+
end_date: T.nilable(Time),
|
1659
|
+
filter: T.nilable(String),
|
1660
|
+
fixed_fee_quantity_transitions:
|
1661
|
+
T.nilable(
|
1662
|
+
T::Array[
|
1663
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition
|
1664
|
+
]
|
1473
1665
|
),
|
1474
|
-
|
1475
|
-
|
1476
|
-
Orb::
|
1477
|
-
Orb::
|
1478
|
-
Orb::
|
1479
|
-
Orb::
|
1480
|
-
Orb::
|
1481
|
-
Orb::
|
1482
|
-
Orb::
|
1483
|
-
Orb::
|
1484
|
-
Orb::
|
1485
|
-
Orb::
|
1486
|
-
Orb::
|
1487
|
-
Orb::
|
1488
|
-
Orb::
|
1489
|
-
Orb::
|
1490
|
-
Orb::
|
1491
|
-
Orb::
|
1492
|
-
Orb::
|
1493
|
-
Orb::
|
1494
|
-
Orb::
|
1495
|
-
Orb::
|
1496
|
-
Orb::
|
1497
|
-
Orb::
|
1498
|
-
Orb::
|
1499
|
-
Orb::
|
1500
|
-
Orb::
|
1501
|
-
Orb::
|
1502
|
-
Orb::
|
1666
|
+
price:
|
1667
|
+
T.any(
|
1668
|
+
Orb::Price::Unit,
|
1669
|
+
Orb::Price::Package,
|
1670
|
+
Orb::Price::Matrix,
|
1671
|
+
Orb::Price::Tiered,
|
1672
|
+
Orb::Price::TieredBps,
|
1673
|
+
Orb::Price::Bps,
|
1674
|
+
Orb::Price::BulkBps,
|
1675
|
+
Orb::Price::Bulk,
|
1676
|
+
Orb::Price::ThresholdTotalAmount,
|
1677
|
+
Orb::Price::TieredPackage,
|
1678
|
+
Orb::Price::GroupedTiered,
|
1679
|
+
Orb::Price::TieredWithMinimum,
|
1680
|
+
Orb::Price::TieredPackageWithMinimum,
|
1681
|
+
Orb::Price::PackageWithAllocation,
|
1682
|
+
Orb::Price::UnitWithPercent,
|
1683
|
+
Orb::Price::MatrixWithAllocation,
|
1684
|
+
Orb::Price::TieredWithProration,
|
1685
|
+
Orb::Price::UnitWithProration,
|
1686
|
+
Orb::Price::GroupedAllocation,
|
1687
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1688
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1689
|
+
Orb::Price::MatrixWithDisplayName,
|
1690
|
+
Orb::Price::BulkWithProration,
|
1691
|
+
Orb::Price::GroupedTieredPackage,
|
1692
|
+
Orb::Price::MaxGroupTieredPackage,
|
1693
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1694
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1695
|
+
Orb::Price::CumulativeGroupedBulk
|
1503
1696
|
),
|
1504
|
-
|
1505
|
-
|
1506
|
-
|
1507
|
-
|
1697
|
+
start_date: Time,
|
1698
|
+
usage_customer_ids: T.nilable(T::Array[String])
|
1699
|
+
}
|
1700
|
+
)
|
1701
|
+
end
|
1702
|
+
def to_hash
|
1508
1703
|
end
|
1509
|
-
def to_hash; end
|
1510
1704
|
|
1511
1705
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1706
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1707
|
+
|
1512
1708
|
sig { returns(Time) }
|
1513
1709
|
attr_accessor :effective_date
|
1514
1710
|
|
@@ -1518,15 +1714,29 @@ module Orb
|
|
1518
1714
|
sig { returns(Integer) }
|
1519
1715
|
attr_accessor :quantity
|
1520
1716
|
|
1521
|
-
sig
|
1522
|
-
|
1717
|
+
sig do
|
1718
|
+
params(
|
1719
|
+
effective_date: Time,
|
1720
|
+
price_id: String,
|
1721
|
+
quantity: Integer
|
1722
|
+
).returns(T.attached_class)
|
1723
|
+
end
|
1724
|
+
def self.new(effective_date:, price_id:, quantity:)
|
1725
|
+
end
|
1523
1726
|
|
1524
|
-
sig
|
1525
|
-
|
1727
|
+
sig do
|
1728
|
+
override.returns(
|
1729
|
+
{ effective_date: Time, price_id: String, quantity: Integer }
|
1730
|
+
)
|
1731
|
+
end
|
1732
|
+
def to_hash
|
1733
|
+
end
|
1526
1734
|
end
|
1527
1735
|
end
|
1528
1736
|
|
1529
1737
|
class RedeemedCoupon < Orb::Internal::Type::BaseModel
|
1738
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1739
|
+
|
1530
1740
|
sig { returns(String) }
|
1531
1741
|
attr_accessor :coupon_id
|
1532
1742
|
|
@@ -1537,55 +1747,95 @@ module Orb
|
|
1537
1747
|
attr_accessor :start_date
|
1538
1748
|
|
1539
1749
|
sig do
|
1540
|
-
params(
|
1750
|
+
params(
|
1751
|
+
coupon_id: String,
|
1752
|
+
end_date: T.nilable(Time),
|
1753
|
+
start_date: Time
|
1754
|
+
).returns(T.attached_class)
|
1755
|
+
end
|
1756
|
+
def self.new(coupon_id:, end_date:, start_date:)
|
1541
1757
|
end
|
1542
|
-
def self.new(coupon_id:, end_date:, start_date:); end
|
1543
1758
|
|
1544
|
-
sig
|
1545
|
-
|
1759
|
+
sig do
|
1760
|
+
override.returns(
|
1761
|
+
{ coupon_id: String, end_date: T.nilable(Time), start_date: Time }
|
1762
|
+
)
|
1763
|
+
end
|
1764
|
+
def to_hash
|
1765
|
+
end
|
1546
1766
|
end
|
1547
1767
|
|
1548
1768
|
module Status
|
1549
1769
|
extend Orb::Internal::Type::Enum
|
1550
1770
|
|
1551
1771
|
TaggedSymbol =
|
1552
|
-
T.type_alias
|
1772
|
+
T.type_alias do
|
1773
|
+
T.all(
|
1774
|
+
Symbol,
|
1775
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status
|
1776
|
+
)
|
1777
|
+
end
|
1553
1778
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1554
1779
|
|
1555
|
-
ACTIVE =
|
1556
|
-
|
1557
|
-
|
1780
|
+
ACTIVE =
|
1781
|
+
T.let(
|
1782
|
+
:active,
|
1783
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
1784
|
+
)
|
1785
|
+
ENDED =
|
1786
|
+
T.let(
|
1787
|
+
:ended,
|
1788
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
1789
|
+
)
|
1790
|
+
UPCOMING =
|
1791
|
+
T.let(
|
1792
|
+
:upcoming,
|
1793
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
1794
|
+
)
|
1558
1795
|
|
1559
|
-
sig
|
1560
|
-
|
1796
|
+
sig do
|
1797
|
+
override.returns(
|
1798
|
+
T::Array[
|
1799
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
1800
|
+
]
|
1801
|
+
)
|
1802
|
+
end
|
1803
|
+
def self.values
|
1804
|
+
end
|
1561
1805
|
end
|
1562
1806
|
|
1563
1807
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
1808
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1809
|
+
|
1564
1810
|
sig { returns(T.nilable(Time)) }
|
1565
1811
|
attr_accessor :end_date
|
1566
1812
|
|
1567
1813
|
sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
|
1568
|
-
def self.new(end_date:)
|
1814
|
+
def self.new(end_date:)
|
1815
|
+
end
|
1569
1816
|
|
1570
|
-
sig { override.returns({end_date: T.nilable(Time)}) }
|
1571
|
-
def to_hash
|
1817
|
+
sig { override.returns({ end_date: T.nilable(Time) }) }
|
1818
|
+
def to_hash
|
1819
|
+
end
|
1572
1820
|
end
|
1573
1821
|
|
1574
1822
|
class ChangedResources < Orb::Internal::Type::BaseModel
|
1823
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1824
|
+
|
1575
1825
|
# The credit notes that were created as part of this operation.
|
1576
|
-
sig { returns(T::Array[Orb::
|
1826
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1577
1827
|
attr_accessor :created_credit_notes
|
1578
1828
|
|
1579
1829
|
# The invoices that were created as part of this operation.
|
1580
|
-
sig { returns(T::Array[Orb::
|
1830
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1581
1831
|
attr_accessor :created_invoices
|
1582
1832
|
|
1583
1833
|
# The credit notes that were voided as part of this operation.
|
1584
|
-
sig { returns(T::Array[Orb::
|
1834
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1585
1835
|
attr_accessor :voided_credit_notes
|
1586
1836
|
|
1587
1837
|
# The invoices that were voided as part of this operation.
|
1588
|
-
sig { returns(T::Array[Orb::
|
1838
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1589
1839
|
attr_accessor :voided_invoices
|
1590
1840
|
|
1591
1841
|
# The resources that were changed as part of this operation. Only present when
|
@@ -1593,12 +1843,11 @@ module Orb
|
|
1593
1843
|
# `include_changed_resources` parameter was passed in the request.
|
1594
1844
|
sig do
|
1595
1845
|
params(
|
1596
|
-
created_credit_notes: T::Array[
|
1597
|
-
created_invoices: T::Array[
|
1598
|
-
voided_credit_notes: T::Array[
|
1599
|
-
voided_invoices: T::Array[
|
1600
|
-
)
|
1601
|
-
.returns(T.attached_class)
|
1846
|
+
created_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1847
|
+
created_invoices: T::Array[Orb::Invoice::OrHash],
|
1848
|
+
voided_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1849
|
+
voided_invoices: T::Array[Orb::Invoice::OrHash]
|
1850
|
+
).returns(T.attached_class)
|
1602
1851
|
end
|
1603
1852
|
def self.new(
|
1604
1853
|
# The credit notes that were created as part of this operation.
|
@@ -1609,19 +1858,21 @@ module Orb
|
|
1609
1858
|
voided_credit_notes:,
|
1610
1859
|
# The invoices that were voided as part of this operation.
|
1611
1860
|
voided_invoices:
|
1612
|
-
)
|
1861
|
+
)
|
1862
|
+
end
|
1863
|
+
|
1613
1864
|
sig do
|
1614
|
-
override
|
1615
|
-
|
1616
|
-
|
1617
|
-
|
1618
|
-
|
1619
|
-
|
1620
|
-
|
1621
|
-
|
1622
|
-
|
1865
|
+
override.returns(
|
1866
|
+
{
|
1867
|
+
created_credit_notes: T::Array[Orb::CreditNote],
|
1868
|
+
created_invoices: T::Array[Orb::Invoice],
|
1869
|
+
voided_credit_notes: T::Array[Orb::CreditNote],
|
1870
|
+
voided_invoices: T::Array[Orb::Invoice]
|
1871
|
+
}
|
1872
|
+
)
|
1873
|
+
end
|
1874
|
+
def to_hash
|
1623
1875
|
end
|
1624
|
-
def to_hash; end
|
1625
1876
|
end
|
1626
1877
|
end
|
1627
1878
|
end
|