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 SubscriptionTriggerPhaseResponse < 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::SubscriptionTriggerPhaseResponse::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::SubscriptionTriggerPhaseResponse::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::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration
|
32
|
-
|
33
|
-
)
|
34
|
-
)
|
35
|
-
.void
|
42
|
+
billing_cycle_anchor_configuration:
|
43
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::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::SubscriptionTriggerPhaseResponse::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::SubscriptionTriggerPhaseResponse::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::SubscriptionTriggerPhaseResponse::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,16 +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::SubscriptionTriggerPhaseResponse::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
|
-
|
145
|
-
|
146
|
-
|
175
|
+
pending_subscription_change:
|
176
|
+
T.nilable(
|
177
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange::OrHash
|
178
|
+
)
|
179
|
+
).void
|
147
180
|
end
|
148
181
|
attr_writer :pending_subscription_change
|
149
182
|
|
@@ -151,24 +184,36 @@ module Orb
|
|
151
184
|
# subscribed to by a customer. Plans define the billing behavior of the
|
152
185
|
# subscription. You can see more about how to configure prices in the
|
153
186
|
# [Price resource](/reference/price).
|
154
|
-
sig { returns(Orb::
|
187
|
+
sig { returns(Orb::Plan) }
|
155
188
|
attr_reader :plan
|
156
189
|
|
157
|
-
sig { params(plan:
|
190
|
+
sig { params(plan: Orb::Plan::OrHash).void }
|
158
191
|
attr_writer :plan
|
159
192
|
|
160
193
|
# The price intervals for this subscription.
|
161
|
-
sig
|
194
|
+
sig do
|
195
|
+
returns(
|
196
|
+
T::Array[Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval]
|
197
|
+
)
|
198
|
+
end
|
162
199
|
attr_accessor :price_intervals
|
163
200
|
|
164
|
-
sig
|
201
|
+
sig do
|
202
|
+
returns(
|
203
|
+
T.nilable(
|
204
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon
|
205
|
+
)
|
206
|
+
)
|
207
|
+
end
|
165
208
|
attr_reader :redeemed_coupon
|
166
209
|
|
167
210
|
sig do
|
168
211
|
params(
|
169
|
-
redeemed_coupon:
|
170
|
-
|
171
|
-
|
212
|
+
redeemed_coupon:
|
213
|
+
T.nilable(
|
214
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon::OrHash
|
215
|
+
)
|
216
|
+
).void
|
172
217
|
end
|
173
218
|
attr_writer :redeemed_coupon
|
174
219
|
|
@@ -176,7 +221,11 @@ module Orb
|
|
176
221
|
sig { returns(Time) }
|
177
222
|
attr_accessor :start_date
|
178
223
|
|
179
|
-
sig
|
224
|
+
sig do
|
225
|
+
returns(
|
226
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol
|
227
|
+
)
|
228
|
+
end
|
180
229
|
attr_accessor :status
|
181
230
|
|
182
231
|
sig { returns(Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo) }
|
@@ -184,23 +233,31 @@ module Orb
|
|
184
233
|
|
185
234
|
sig do
|
186
235
|
params(
|
187
|
-
trial_info:
|
188
|
-
|
189
|
-
|
236
|
+
trial_info:
|
237
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo::OrHash
|
238
|
+
).void
|
190
239
|
end
|
191
240
|
attr_writer :trial_info
|
192
241
|
|
193
242
|
# The resources that were changed as part of this operation. Only present when
|
194
243
|
# fetched through the subscription changes API or if the
|
195
244
|
# `include_changed_resources` parameter was passed in the request.
|
196
|
-
sig
|
245
|
+
sig do
|
246
|
+
returns(
|
247
|
+
T.nilable(
|
248
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources
|
249
|
+
)
|
250
|
+
)
|
251
|
+
end
|
197
252
|
attr_reader :changed_resources
|
198
253
|
|
199
254
|
sig do
|
200
255
|
params(
|
201
|
-
changed_resources:
|
202
|
-
|
203
|
-
|
256
|
+
changed_resources:
|
257
|
+
T.nilable(
|
258
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources::OrHash
|
259
|
+
)
|
260
|
+
).void
|
204
261
|
end
|
205
262
|
attr_writer :changed_resources
|
206
263
|
|
@@ -208,45 +265,66 @@ module Orb
|
|
208
265
|
params(
|
209
266
|
id: String,
|
210
267
|
active_plan_phase_order: T.nilable(Integer),
|
211
|
-
adjustment_intervals:
|
268
|
+
adjustment_intervals:
|
269
|
+
T::Array[
|
270
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::OrHash
|
271
|
+
],
|
212
272
|
auto_collection: T.nilable(T::Boolean),
|
213
|
-
billing_cycle_anchor_configuration:
|
214
|
-
Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration,
|
215
|
-
Orb::Internal::AnyHash
|
216
|
-
),
|
273
|
+
billing_cycle_anchor_configuration:
|
274
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration::OrHash,
|
217
275
|
billing_cycle_day: Integer,
|
218
276
|
created_at: Time,
|
219
277
|
current_billing_period_end_date: T.nilable(Time),
|
220
278
|
current_billing_period_start_date: T.nilable(Time),
|
221
|
-
customer:
|
279
|
+
customer: Orb::Customer::OrHash,
|
222
280
|
default_invoice_memo: T.nilable(String),
|
223
|
-
discount_intervals:
|
224
|
-
T
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
281
|
+
discount_intervals:
|
282
|
+
T::Array[
|
283
|
+
T.any(
|
284
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount::OrHash,
|
285
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage::OrHash,
|
286
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage::OrHash
|
287
|
+
)
|
288
|
+
],
|
231
289
|
end_date: T.nilable(Time),
|
232
|
-
fixed_fee_quantity_schedule:
|
290
|
+
fixed_fee_quantity_schedule:
|
291
|
+
T::Array[
|
292
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::FixedFeeQuantitySchedule::OrHash
|
293
|
+
],
|
233
294
|
invoicing_threshold: T.nilable(String),
|
234
|
-
maximum_intervals:
|
295
|
+
maximum_intervals:
|
296
|
+
T::Array[
|
297
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval::OrHash
|
298
|
+
],
|
235
299
|
metadata: T::Hash[Symbol, String],
|
236
|
-
minimum_intervals:
|
300
|
+
minimum_intervals:
|
301
|
+
T::Array[
|
302
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval::OrHash
|
303
|
+
],
|
237
304
|
net_terms: Integer,
|
238
|
-
pending_subscription_change:
|
239
|
-
T.
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
305
|
+
pending_subscription_change:
|
306
|
+
T.nilable(
|
307
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange::OrHash
|
308
|
+
),
|
309
|
+
plan: Orb::Plan::OrHash,
|
310
|
+
price_intervals:
|
311
|
+
T::Array[
|
312
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::OrHash
|
313
|
+
],
|
314
|
+
redeemed_coupon:
|
315
|
+
T.nilable(
|
316
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon::OrHash
|
317
|
+
),
|
244
318
|
start_date: Time,
|
245
|
-
status:
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
319
|
+
status:
|
320
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::Status::OrSymbol,
|
321
|
+
trial_info:
|
322
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo::OrHash,
|
323
|
+
changed_resources:
|
324
|
+
T.nilable(
|
325
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources::OrHash
|
326
|
+
)
|
327
|
+
).returns(T.attached_class)
|
250
328
|
end
|
251
329
|
def self.new(
|
252
330
|
id:,
|
@@ -335,50 +413,82 @@ module Orb
|
|
335
413
|
# fetched through the subscription changes API or if the
|
336
414
|
# `include_changed_resources` parameter was passed in the request.
|
337
415
|
changed_resources: nil
|
338
|
-
)
|
416
|
+
)
|
417
|
+
end
|
418
|
+
|
339
419
|
sig do
|
340
|
-
override
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
420
|
+
override.returns(
|
421
|
+
{
|
422
|
+
id: String,
|
423
|
+
active_plan_phase_order: T.nilable(Integer),
|
424
|
+
adjustment_intervals:
|
425
|
+
T::Array[
|
426
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval
|
427
|
+
],
|
428
|
+
auto_collection: T.nilable(T::Boolean),
|
429
|
+
billing_cycle_anchor_configuration:
|
430
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::BillingCycleAnchorConfiguration,
|
431
|
+
billing_cycle_day: Integer,
|
432
|
+
created_at: Time,
|
433
|
+
current_billing_period_end_date: T.nilable(Time),
|
434
|
+
current_billing_period_start_date: T.nilable(Time),
|
435
|
+
customer: Orb::Customer,
|
436
|
+
default_invoice_memo: T.nilable(String),
|
437
|
+
discount_intervals:
|
438
|
+
T::Array[
|
355
439
|
T.any(
|
356
440
|
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount,
|
357
441
|
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage,
|
358
442
|
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage
|
359
443
|
)
|
360
444
|
],
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
445
|
+
end_date: T.nilable(Time),
|
446
|
+
fixed_fee_quantity_schedule:
|
447
|
+
T::Array[
|
448
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::FixedFeeQuantitySchedule
|
449
|
+
],
|
450
|
+
invoicing_threshold: T.nilable(String),
|
451
|
+
maximum_intervals:
|
452
|
+
T::Array[
|
453
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::MaximumInterval
|
454
|
+
],
|
455
|
+
metadata: T::Hash[Symbol, String],
|
456
|
+
minimum_intervals:
|
457
|
+
T::Array[
|
458
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::MinimumInterval
|
459
|
+
],
|
460
|
+
net_terms: Integer,
|
461
|
+
pending_subscription_change:
|
462
|
+
T.nilable(
|
463
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::PendingSubscriptionChange
|
464
|
+
),
|
465
|
+
plan: Orb::Plan,
|
466
|
+
price_intervals:
|
467
|
+
T::Array[
|
468
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval
|
469
|
+
],
|
470
|
+
redeemed_coupon:
|
471
|
+
T.nilable(
|
472
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::RedeemedCoupon
|
473
|
+
),
|
474
|
+
start_date: Time,
|
475
|
+
status:
|
476
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol,
|
477
|
+
trial_info:
|
478
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::TrialInfo,
|
479
|
+
changed_resources:
|
480
|
+
T.nilable(
|
481
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::ChangedResources
|
482
|
+
)
|
483
|
+
}
|
484
|
+
)
|
485
|
+
end
|
486
|
+
def to_hash
|
378
487
|
end
|
379
|
-
def to_hash; end
|
380
488
|
|
381
489
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
490
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
491
|
+
|
382
492
|
sig { returns(String) }
|
383
493
|
attr_accessor :id
|
384
494
|
|
@@ -410,19 +520,18 @@ module Orb
|
|
410
520
|
sig do
|
411
521
|
params(
|
412
522
|
id: String,
|
413
|
-
adjustment:
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
|
418
|
-
|
419
|
-
|
420
|
-
|
523
|
+
adjustment:
|
524
|
+
T.any(
|
525
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount::OrHash,
|
526
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount::OrHash,
|
527
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount::OrHash,
|
528
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum::OrHash,
|
529
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum::OrHash
|
530
|
+
),
|
421
531
|
applies_to_price_interval_ids: T::Array[String],
|
422
532
|
end_date: T.nilable(Time),
|
423
533
|
start_date: Time
|
424
|
-
)
|
425
|
-
.returns(T.attached_class)
|
534
|
+
).returns(T.attached_class)
|
426
535
|
end
|
427
536
|
def self.new(
|
428
537
|
id:,
|
@@ -433,31 +542,47 @@ module Orb
|
|
433
542
|
end_date:,
|
434
543
|
# The start date of the adjustment interval.
|
435
544
|
start_date:
|
436
|
-
)
|
545
|
+
)
|
546
|
+
end
|
547
|
+
|
437
548
|
sig do
|
438
|
-
override
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
549
|
+
override.returns(
|
550
|
+
{
|
551
|
+
id: String,
|
552
|
+
adjustment:
|
553
|
+
T.any(
|
443
554
|
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
444
555
|
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
445
556
|
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
446
557
|
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum,
|
447
558
|
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum
|
448
559
|
),
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
560
|
+
applies_to_price_interval_ids: T::Array[String],
|
561
|
+
end_date: T.nilable(Time),
|
562
|
+
start_date: Time
|
563
|
+
}
|
564
|
+
)
|
565
|
+
end
|
566
|
+
def to_hash
|
454
567
|
end
|
455
|
-
def to_hash; end
|
456
568
|
|
457
569
|
module Adjustment
|
458
570
|
extend Orb::Internal::Type::Union
|
459
571
|
|
572
|
+
Variants =
|
573
|
+
T.type_alias do
|
574
|
+
T.any(
|
575
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
576
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
577
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
578
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum,
|
579
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum
|
580
|
+
)
|
581
|
+
end
|
582
|
+
|
460
583
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
584
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
585
|
+
|
461
586
|
sig { returns(String) }
|
462
587
|
attr_accessor :id
|
463
588
|
|
@@ -495,8 +620,7 @@ module Orb
|
|
495
620
|
reason: T.nilable(String),
|
496
621
|
usage_discount: Float,
|
497
622
|
adjustment_type: Symbol
|
498
|
-
)
|
499
|
-
.returns(T.attached_class)
|
623
|
+
).returns(T.attached_class)
|
500
624
|
end
|
501
625
|
def self.new(
|
502
626
|
id:,
|
@@ -513,25 +637,29 @@ module Orb
|
|
513
637
|
# to in a given billing period.
|
514
638
|
usage_discount:,
|
515
639
|
adjustment_type: :usage_discount
|
516
|
-
)
|
640
|
+
)
|
641
|
+
end
|
642
|
+
|
517
643
|
sig do
|
518
|
-
override
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
644
|
+
override.returns(
|
645
|
+
{
|
646
|
+
id: String,
|
647
|
+
adjustment_type: Symbol,
|
648
|
+
applies_to_price_ids: T::Array[String],
|
649
|
+
is_invoice_level: T::Boolean,
|
650
|
+
plan_phase_order: T.nilable(Integer),
|
651
|
+
reason: T.nilable(String),
|
652
|
+
usage_discount: Float
|
653
|
+
}
|
654
|
+
)
|
655
|
+
end
|
656
|
+
def to_hash
|
530
657
|
end
|
531
|
-
def to_hash; end
|
532
658
|
end
|
533
659
|
|
534
660
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
661
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
662
|
+
|
535
663
|
sig { returns(String) }
|
536
664
|
attr_accessor :id
|
537
665
|
|
@@ -569,8 +697,7 @@ module Orb
|
|
569
697
|
plan_phase_order: T.nilable(Integer),
|
570
698
|
reason: T.nilable(String),
|
571
699
|
adjustment_type: Symbol
|
572
|
-
)
|
573
|
-
.returns(T.attached_class)
|
700
|
+
).returns(T.attached_class)
|
574
701
|
end
|
575
702
|
def self.new(
|
576
703
|
id:,
|
@@ -587,25 +714,29 @@ module Orb
|
|
587
714
|
# The reason for the adjustment.
|
588
715
|
reason:,
|
589
716
|
adjustment_type: :amount_discount
|
590
|
-
)
|
717
|
+
)
|
718
|
+
end
|
719
|
+
|
591
720
|
sig do
|
592
|
-
override
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
721
|
+
override.returns(
|
722
|
+
{
|
723
|
+
id: String,
|
724
|
+
adjustment_type: Symbol,
|
725
|
+
amount_discount: String,
|
726
|
+
applies_to_price_ids: T::Array[String],
|
727
|
+
is_invoice_level: T::Boolean,
|
728
|
+
plan_phase_order: T.nilable(Integer),
|
729
|
+
reason: T.nilable(String)
|
730
|
+
}
|
731
|
+
)
|
732
|
+
end
|
733
|
+
def to_hash
|
604
734
|
end
|
605
|
-
def to_hash; end
|
606
735
|
end
|
607
736
|
|
608
737
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
738
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
739
|
+
|
609
740
|
sig { returns(String) }
|
610
741
|
attr_accessor :id
|
611
742
|
|
@@ -643,8 +774,7 @@ module Orb
|
|
643
774
|
plan_phase_order: T.nilable(Integer),
|
644
775
|
reason: T.nilable(String),
|
645
776
|
adjustment_type: Symbol
|
646
|
-
)
|
647
|
-
.returns(T.attached_class)
|
777
|
+
).returns(T.attached_class)
|
648
778
|
end
|
649
779
|
def self.new(
|
650
780
|
id:,
|
@@ -661,25 +791,29 @@ module Orb
|
|
661
791
|
# The reason for the adjustment.
|
662
792
|
reason:,
|
663
793
|
adjustment_type: :percentage_discount
|
664
|
-
)
|
794
|
+
)
|
795
|
+
end
|
796
|
+
|
665
797
|
sig do
|
666
|
-
override
|
667
|
-
|
668
|
-
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
|
798
|
+
override.returns(
|
799
|
+
{
|
800
|
+
id: String,
|
801
|
+
adjustment_type: Symbol,
|
802
|
+
applies_to_price_ids: T::Array[String],
|
803
|
+
is_invoice_level: T::Boolean,
|
804
|
+
percentage_discount: Float,
|
805
|
+
plan_phase_order: T.nilable(Integer),
|
806
|
+
reason: T.nilable(String)
|
807
|
+
}
|
808
|
+
)
|
809
|
+
end
|
810
|
+
def to_hash
|
678
811
|
end
|
679
|
-
def to_hash; end
|
680
812
|
end
|
681
813
|
|
682
814
|
class Minimum < Orb::Internal::Type::BaseModel
|
815
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
816
|
+
|
683
817
|
sig { returns(String) }
|
684
818
|
attr_accessor :id
|
685
819
|
|
@@ -722,8 +856,7 @@ module Orb
|
|
722
856
|
plan_phase_order: T.nilable(Integer),
|
723
857
|
reason: T.nilable(String),
|
724
858
|
adjustment_type: Symbol
|
725
|
-
)
|
726
|
-
.returns(T.attached_class)
|
859
|
+
).returns(T.attached_class)
|
727
860
|
end
|
728
861
|
def self.new(
|
729
862
|
id:,
|
@@ -742,26 +875,30 @@ module Orb
|
|
742
875
|
# The reason for the adjustment.
|
743
876
|
reason:,
|
744
877
|
adjustment_type: :minimum
|
745
|
-
)
|
878
|
+
)
|
879
|
+
end
|
880
|
+
|
746
881
|
sig do
|
747
|
-
override
|
748
|
-
|
749
|
-
|
750
|
-
|
751
|
-
|
752
|
-
|
753
|
-
|
754
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
|
882
|
+
override.returns(
|
883
|
+
{
|
884
|
+
id: String,
|
885
|
+
adjustment_type: Symbol,
|
886
|
+
applies_to_price_ids: T::Array[String],
|
887
|
+
is_invoice_level: T::Boolean,
|
888
|
+
item_id: String,
|
889
|
+
minimum_amount: String,
|
890
|
+
plan_phase_order: T.nilable(Integer),
|
891
|
+
reason: T.nilable(String)
|
892
|
+
}
|
893
|
+
)
|
894
|
+
end
|
895
|
+
def to_hash
|
760
896
|
end
|
761
|
-
def to_hash; end
|
762
897
|
end
|
763
898
|
|
764
899
|
class Maximum < Orb::Internal::Type::BaseModel
|
900
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
901
|
+
|
765
902
|
sig { returns(String) }
|
766
903
|
attr_accessor :id
|
767
904
|
|
@@ -799,8 +936,7 @@ module Orb
|
|
799
936
|
plan_phase_order: T.nilable(Integer),
|
800
937
|
reason: T.nilable(String),
|
801
938
|
adjustment_type: Symbol
|
802
|
-
)
|
803
|
-
.returns(T.attached_class)
|
939
|
+
).returns(T.attached_class)
|
804
940
|
end
|
805
941
|
def self.new(
|
806
942
|
id:,
|
@@ -817,35 +953,41 @@ module Orb
|
|
817
953
|
# The reason for the adjustment.
|
818
954
|
reason:,
|
819
955
|
adjustment_type: :maximum
|
820
|
-
)
|
956
|
+
)
|
957
|
+
end
|
958
|
+
|
821
959
|
sig do
|
822
|
-
override
|
823
|
-
|
824
|
-
|
825
|
-
|
826
|
-
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
|
960
|
+
override.returns(
|
961
|
+
{
|
962
|
+
id: String,
|
963
|
+
adjustment_type: Symbol,
|
964
|
+
applies_to_price_ids: T::Array[String],
|
965
|
+
is_invoice_level: T::Boolean,
|
966
|
+
maximum_amount: String,
|
967
|
+
plan_phase_order: T.nilable(Integer),
|
968
|
+
reason: T.nilable(String)
|
969
|
+
}
|
970
|
+
)
|
971
|
+
end
|
972
|
+
def to_hash
|
834
973
|
end
|
835
|
-
def to_hash; end
|
836
974
|
end
|
837
975
|
|
838
976
|
sig do
|
839
|
-
override
|
840
|
-
|
841
|
-
|
842
|
-
|
977
|
+
override.returns(
|
978
|
+
T::Array[
|
979
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Variants
|
980
|
+
]
|
981
|
+
)
|
982
|
+
end
|
983
|
+
def self.variants
|
843
984
|
end
|
844
|
-
def self.variants; end
|
845
985
|
end
|
846
986
|
end
|
847
987
|
|
848
988
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
989
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
990
|
+
|
849
991
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
850
992
|
# number of days in a month is greater than this value, the last day of the month
|
851
993
|
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
@@ -865,7 +1007,11 @@ module Orb
|
|
865
1007
|
attr_accessor :year
|
866
1008
|
|
867
1009
|
sig do
|
868
|
-
params(
|
1010
|
+
params(
|
1011
|
+
day: Integer,
|
1012
|
+
month: T.nilable(Integer),
|
1013
|
+
year: T.nilable(Integer)
|
1014
|
+
).returns(T.attached_class)
|
869
1015
|
end
|
870
1016
|
def self.new(
|
871
1017
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
@@ -880,15 +1026,37 @@ module Orb
|
|
880
1026
|
# The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
881
1027
|
# anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
882
1028
|
year: nil
|
883
|
-
)
|
884
|
-
|
885
|
-
|
1029
|
+
)
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
sig do
|
1033
|
+
override.returns(
|
1034
|
+
{
|
1035
|
+
day: Integer,
|
1036
|
+
month: T.nilable(Integer),
|
1037
|
+
year: T.nilable(Integer)
|
1038
|
+
}
|
1039
|
+
)
|
1040
|
+
end
|
1041
|
+
def to_hash
|
1042
|
+
end
|
886
1043
|
end
|
887
1044
|
|
888
1045
|
module DiscountInterval
|
889
1046
|
extend Orb::Internal::Type::Union
|
890
1047
|
|
1048
|
+
Variants =
|
1049
|
+
T.type_alias do
|
1050
|
+
T.any(
|
1051
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount,
|
1052
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage,
|
1053
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage
|
1054
|
+
)
|
1055
|
+
end
|
1056
|
+
|
891
1057
|
class Amount < Orb::Internal::Type::BaseModel
|
1058
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1059
|
+
|
892
1060
|
# Only available if discount_type is `amount`.
|
893
1061
|
sig { returns(String) }
|
894
1062
|
attr_accessor :amount_discount
|
@@ -920,8 +1088,7 @@ module Orb
|
|
920
1088
|
end_date: T.nilable(Time),
|
921
1089
|
start_date: Time,
|
922
1090
|
discount_type: Symbol
|
923
|
-
)
|
924
|
-
.returns(T.attached_class)
|
1091
|
+
).returns(T.attached_class)
|
925
1092
|
end
|
926
1093
|
def self.new(
|
927
1094
|
# Only available if discount_type is `amount`.
|
@@ -935,24 +1102,28 @@ module Orb
|
|
935
1102
|
# The start date of the discount interval.
|
936
1103
|
start_date:,
|
937
1104
|
discount_type: :amount
|
938
|
-
)
|
1105
|
+
)
|
1106
|
+
end
|
1107
|
+
|
939
1108
|
sig do
|
940
|
-
override
|
941
|
-
|
942
|
-
|
943
|
-
|
944
|
-
|
945
|
-
|
946
|
-
|
947
|
-
|
948
|
-
|
949
|
-
|
950
|
-
|
1109
|
+
override.returns(
|
1110
|
+
{
|
1111
|
+
amount_discount: String,
|
1112
|
+
applies_to_price_ids: T::Array[String],
|
1113
|
+
applies_to_price_interval_ids: T::Array[String],
|
1114
|
+
discount_type: Symbol,
|
1115
|
+
end_date: T.nilable(Time),
|
1116
|
+
start_date: Time
|
1117
|
+
}
|
1118
|
+
)
|
1119
|
+
end
|
1120
|
+
def to_hash
|
951
1121
|
end
|
952
|
-
def to_hash; end
|
953
1122
|
end
|
954
1123
|
|
955
1124
|
class Percentage < Orb::Internal::Type::BaseModel
|
1125
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1126
|
+
|
956
1127
|
# The price ids that this discount interval applies to.
|
957
1128
|
sig { returns(T::Array[String]) }
|
958
1129
|
attr_accessor :applies_to_price_ids
|
@@ -985,8 +1156,7 @@ module Orb
|
|
985
1156
|
percentage_discount: Float,
|
986
1157
|
start_date: Time,
|
987
1158
|
discount_type: Symbol
|
988
|
-
)
|
989
|
-
.returns(T.attached_class)
|
1159
|
+
).returns(T.attached_class)
|
990
1160
|
end
|
991
1161
|
def self.new(
|
992
1162
|
# The price ids that this discount interval applies to.
|
@@ -1001,24 +1171,28 @@ module Orb
|
|
1001
1171
|
# The start date of the discount interval.
|
1002
1172
|
start_date:,
|
1003
1173
|
discount_type: :percentage
|
1004
|
-
)
|
1174
|
+
)
|
1175
|
+
end
|
1176
|
+
|
1005
1177
|
sig do
|
1006
|
-
override
|
1007
|
-
|
1008
|
-
|
1009
|
-
|
1010
|
-
|
1011
|
-
|
1012
|
-
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1178
|
+
override.returns(
|
1179
|
+
{
|
1180
|
+
applies_to_price_ids: T::Array[String],
|
1181
|
+
applies_to_price_interval_ids: T::Array[String],
|
1182
|
+
discount_type: Symbol,
|
1183
|
+
end_date: T.nilable(Time),
|
1184
|
+
percentage_discount: Float,
|
1185
|
+
start_date: Time
|
1186
|
+
}
|
1187
|
+
)
|
1188
|
+
end
|
1189
|
+
def to_hash
|
1017
1190
|
end
|
1018
|
-
def to_hash; end
|
1019
1191
|
end
|
1020
1192
|
|
1021
1193
|
class Usage < Orb::Internal::Type::BaseModel
|
1194
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1195
|
+
|
1022
1196
|
# The price ids that this discount interval applies to.
|
1023
1197
|
sig { returns(T::Array[String]) }
|
1024
1198
|
attr_accessor :applies_to_price_ids
|
@@ -1051,8 +1225,7 @@ module Orb
|
|
1051
1225
|
start_date: Time,
|
1052
1226
|
usage_discount: Float,
|
1053
1227
|
discount_type: Symbol
|
1054
|
-
)
|
1055
|
-
.returns(T.attached_class)
|
1228
|
+
).returns(T.attached_class)
|
1056
1229
|
end
|
1057
1230
|
def self.new(
|
1058
1231
|
# The price ids that this discount interval applies to.
|
@@ -1067,33 +1240,39 @@ module Orb
|
|
1067
1240
|
# discount is for
|
1068
1241
|
usage_discount:,
|
1069
1242
|
discount_type: :usage
|
1070
|
-
)
|
1243
|
+
)
|
1244
|
+
end
|
1245
|
+
|
1071
1246
|
sig do
|
1072
|
-
override
|
1073
|
-
|
1074
|
-
|
1075
|
-
|
1076
|
-
|
1077
|
-
|
1078
|
-
|
1079
|
-
|
1080
|
-
|
1081
|
-
|
1082
|
-
|
1247
|
+
override.returns(
|
1248
|
+
{
|
1249
|
+
applies_to_price_ids: T::Array[String],
|
1250
|
+
applies_to_price_interval_ids: T::Array[String],
|
1251
|
+
discount_type: Symbol,
|
1252
|
+
end_date: T.nilable(Time),
|
1253
|
+
start_date: Time,
|
1254
|
+
usage_discount: Float
|
1255
|
+
}
|
1256
|
+
)
|
1257
|
+
end
|
1258
|
+
def to_hash
|
1083
1259
|
end
|
1084
|
-
def to_hash; end
|
1085
1260
|
end
|
1086
1261
|
|
1087
1262
|
sig do
|
1088
|
-
override
|
1089
|
-
|
1090
|
-
|
1091
|
-
|
1263
|
+
override.returns(
|
1264
|
+
T::Array[
|
1265
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Variants
|
1266
|
+
]
|
1267
|
+
)
|
1268
|
+
end
|
1269
|
+
def self.variants
|
1092
1270
|
end
|
1093
|
-
def self.variants; end
|
1094
1271
|
end
|
1095
1272
|
|
1096
1273
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
1274
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1275
|
+
|
1097
1276
|
sig { returns(T.nilable(Time)) }
|
1098
1277
|
attr_accessor :end_date
|
1099
1278
|
|
@@ -1107,18 +1286,33 @@ module Orb
|
|
1107
1286
|
attr_accessor :start_date
|
1108
1287
|
|
1109
1288
|
sig do
|
1110
|
-
params(
|
1111
|
-
.
|
1289
|
+
params(
|
1290
|
+
end_date: T.nilable(Time),
|
1291
|
+
price_id: String,
|
1292
|
+
quantity: Float,
|
1293
|
+
start_date: Time
|
1294
|
+
).returns(T.attached_class)
|
1295
|
+
end
|
1296
|
+
def self.new(end_date:, price_id:, quantity:, start_date:)
|
1112
1297
|
end
|
1113
|
-
def self.new(end_date:, price_id:, quantity:, start_date:); end
|
1114
1298
|
|
1115
1299
|
sig do
|
1116
|
-
override.returns(
|
1300
|
+
override.returns(
|
1301
|
+
{
|
1302
|
+
end_date: T.nilable(Time),
|
1303
|
+
price_id: String,
|
1304
|
+
quantity: Float,
|
1305
|
+
start_date: Time
|
1306
|
+
}
|
1307
|
+
)
|
1308
|
+
end
|
1309
|
+
def to_hash
|
1117
1310
|
end
|
1118
|
-
def to_hash; end
|
1119
1311
|
end
|
1120
1312
|
|
1121
1313
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
1314
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1315
|
+
|
1122
1316
|
# The price ids that this maximum interval applies to.
|
1123
1317
|
sig { returns(T::Array[String]) }
|
1124
1318
|
attr_accessor :applies_to_price_ids
|
@@ -1147,8 +1341,7 @@ module Orb
|
|
1147
1341
|
end_date: T.nilable(Time),
|
1148
1342
|
maximum_amount: String,
|
1149
1343
|
start_date: Time
|
1150
|
-
)
|
1151
|
-
.returns(T.attached_class)
|
1344
|
+
).returns(T.attached_class)
|
1152
1345
|
end
|
1153
1346
|
def self.new(
|
1154
1347
|
# The price ids that this maximum interval applies to.
|
@@ -1162,23 +1355,27 @@ module Orb
|
|
1162
1355
|
maximum_amount:,
|
1163
1356
|
# The start date of the maximum interval.
|
1164
1357
|
start_date:
|
1165
|
-
)
|
1358
|
+
)
|
1359
|
+
end
|
1360
|
+
|
1166
1361
|
sig do
|
1167
|
-
override
|
1168
|
-
|
1169
|
-
|
1170
|
-
|
1171
|
-
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1362
|
+
override.returns(
|
1363
|
+
{
|
1364
|
+
applies_to_price_ids: T::Array[String],
|
1365
|
+
applies_to_price_interval_ids: T::Array[String],
|
1366
|
+
end_date: T.nilable(Time),
|
1367
|
+
maximum_amount: String,
|
1368
|
+
start_date: Time
|
1369
|
+
}
|
1370
|
+
)
|
1371
|
+
end
|
1372
|
+
def to_hash
|
1177
1373
|
end
|
1178
|
-
def to_hash; end
|
1179
1374
|
end
|
1180
1375
|
|
1181
1376
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
1377
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1378
|
+
|
1182
1379
|
# The price ids that this minimum interval applies to.
|
1183
1380
|
sig { returns(T::Array[String]) }
|
1184
1381
|
attr_accessor :applies_to_price_ids
|
@@ -1207,8 +1404,7 @@ module Orb
|
|
1207
1404
|
end_date: T.nilable(Time),
|
1208
1405
|
minimum_amount: String,
|
1209
1406
|
start_date: Time
|
1210
|
-
)
|
1211
|
-
.returns(T.attached_class)
|
1407
|
+
).returns(T.attached_class)
|
1212
1408
|
end
|
1213
1409
|
def self.new(
|
1214
1410
|
# The price ids that this minimum interval applies to.
|
@@ -1222,35 +1418,43 @@ module Orb
|
|
1222
1418
|
minimum_amount:,
|
1223
1419
|
# The start date of the minimum interval.
|
1224
1420
|
start_date:
|
1225
|
-
)
|
1421
|
+
)
|
1422
|
+
end
|
1423
|
+
|
1226
1424
|
sig do
|
1227
|
-
override
|
1228
|
-
|
1229
|
-
|
1230
|
-
|
1231
|
-
|
1232
|
-
|
1233
|
-
|
1234
|
-
|
1235
|
-
|
1236
|
-
|
1425
|
+
override.returns(
|
1426
|
+
{
|
1427
|
+
applies_to_price_ids: T::Array[String],
|
1428
|
+
applies_to_price_interval_ids: T::Array[String],
|
1429
|
+
end_date: T.nilable(Time),
|
1430
|
+
minimum_amount: String,
|
1431
|
+
start_date: Time
|
1432
|
+
}
|
1433
|
+
)
|
1434
|
+
end
|
1435
|
+
def to_hash
|
1237
1436
|
end
|
1238
|
-
def to_hash; end
|
1239
1437
|
end
|
1240
1438
|
|
1241
1439
|
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
1440
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1441
|
+
|
1242
1442
|
sig { returns(String) }
|
1243
1443
|
attr_accessor :id
|
1244
1444
|
|
1245
1445
|
# A pending subscription change if one exists on this subscription.
|
1246
1446
|
sig { params(id: String).returns(T.attached_class) }
|
1247
|
-
def self.new(id:)
|
1447
|
+
def self.new(id:)
|
1448
|
+
end
|
1248
1449
|
|
1249
|
-
sig { override.returns({id: String}) }
|
1250
|
-
def to_hash
|
1450
|
+
sig { override.returns({ id: String }) }
|
1451
|
+
def to_hash
|
1452
|
+
end
|
1251
1453
|
end
|
1252
1454
|
|
1253
1455
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
1456
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1457
|
+
|
1254
1458
|
sig { returns(String) }
|
1255
1459
|
attr_accessor :id
|
1256
1460
|
|
@@ -1284,7 +1488,9 @@ module Orb
|
|
1284
1488
|
sig do
|
1285
1489
|
returns(
|
1286
1490
|
T.nilable(
|
1287
|
-
T::Array[
|
1491
|
+
T::Array[
|
1492
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::FixedFeeQuantityTransition
|
1493
|
+
]
|
1288
1494
|
)
|
1289
1495
|
)
|
1290
1496
|
end
|
@@ -1303,34 +1509,34 @@ module Orb
|
|
1303
1509
|
sig do
|
1304
1510
|
returns(
|
1305
1511
|
T.any(
|
1306
|
-
Orb::
|
1307
|
-
Orb::
|
1308
|
-
Orb::
|
1309
|
-
Orb::
|
1310
|
-
Orb::
|
1311
|
-
Orb::
|
1312
|
-
Orb::
|
1313
|
-
Orb::
|
1314
|
-
Orb::
|
1315
|
-
Orb::
|
1316
|
-
Orb::
|
1317
|
-
Orb::
|
1318
|
-
Orb::
|
1319
|
-
Orb::
|
1320
|
-
Orb::
|
1321
|
-
Orb::
|
1322
|
-
Orb::
|
1323
|
-
Orb::
|
1324
|
-
Orb::
|
1325
|
-
Orb::
|
1326
|
-
Orb::
|
1327
|
-
Orb::
|
1328
|
-
Orb::
|
1329
|
-
Orb::
|
1330
|
-
Orb::
|
1331
|
-
Orb::
|
1332
|
-
Orb::
|
1333
|
-
Orb::
|
1512
|
+
Orb::Price::Unit,
|
1513
|
+
Orb::Price::Package,
|
1514
|
+
Orb::Price::Matrix,
|
1515
|
+
Orb::Price::Tiered,
|
1516
|
+
Orb::Price::TieredBps,
|
1517
|
+
Orb::Price::Bps,
|
1518
|
+
Orb::Price::BulkBps,
|
1519
|
+
Orb::Price::Bulk,
|
1520
|
+
Orb::Price::ThresholdTotalAmount,
|
1521
|
+
Orb::Price::TieredPackage,
|
1522
|
+
Orb::Price::GroupedTiered,
|
1523
|
+
Orb::Price::TieredWithMinimum,
|
1524
|
+
Orb::Price::TieredPackageWithMinimum,
|
1525
|
+
Orb::Price::PackageWithAllocation,
|
1526
|
+
Orb::Price::UnitWithPercent,
|
1527
|
+
Orb::Price::MatrixWithAllocation,
|
1528
|
+
Orb::Price::TieredWithProration,
|
1529
|
+
Orb::Price::UnitWithProration,
|
1530
|
+
Orb::Price::GroupedAllocation,
|
1531
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1532
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1533
|
+
Orb::Price::MatrixWithDisplayName,
|
1534
|
+
Orb::Price::BulkWithProration,
|
1535
|
+
Orb::Price::GroupedTieredPackage,
|
1536
|
+
Orb::Price::MaxGroupTieredPackage,
|
1537
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1538
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1539
|
+
Orb::Price::CumulativeGroupedBulk
|
1334
1540
|
)
|
1335
1541
|
)
|
1336
1542
|
end
|
@@ -1357,49 +1563,46 @@ module Orb
|
|
1357
1563
|
current_billing_period_start_date: T.nilable(Time),
|
1358
1564
|
end_date: T.nilable(Time),
|
1359
1565
|
filter: T.nilable(String),
|
1360
|
-
fixed_fee_quantity_transitions:
|
1361
|
-
T
|
1362
|
-
T
|
1363
|
-
Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::FixedFeeQuantityTransition
|
1364
|
-
|
1365
|
-
|
1366
|
-
|
1367
|
-
|
1368
|
-
|
1369
|
-
|
1370
|
-
|
1371
|
-
|
1372
|
-
|
1373
|
-
|
1374
|
-
|
1375
|
-
|
1376
|
-
|
1377
|
-
|
1378
|
-
|
1379
|
-
|
1380
|
-
|
1381
|
-
|
1382
|
-
|
1383
|
-
|
1384
|
-
|
1385
|
-
|
1386
|
-
|
1387
|
-
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
|
1392
|
-
|
1393
|
-
|
1394
|
-
|
1395
|
-
|
1396
|
-
|
1397
|
-
Orb::Models::Price::CumulativeGroupedBulk
|
1398
|
-
),
|
1566
|
+
fixed_fee_quantity_transitions:
|
1567
|
+
T.nilable(
|
1568
|
+
T::Array[
|
1569
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::FixedFeeQuantityTransition::OrHash
|
1570
|
+
]
|
1571
|
+
),
|
1572
|
+
price:
|
1573
|
+
T.any(
|
1574
|
+
Orb::Price::Unit::OrHash,
|
1575
|
+
Orb::Price::Package::OrHash,
|
1576
|
+
Orb::Price::Matrix::OrHash,
|
1577
|
+
Orb::Price::Tiered::OrHash,
|
1578
|
+
Orb::Price::TieredBps::OrHash,
|
1579
|
+
Orb::Price::Bps::OrHash,
|
1580
|
+
Orb::Price::BulkBps::OrHash,
|
1581
|
+
Orb::Price::Bulk::OrHash,
|
1582
|
+
Orb::Price::ThresholdTotalAmount::OrHash,
|
1583
|
+
Orb::Price::TieredPackage::OrHash,
|
1584
|
+
Orb::Price::GroupedTiered::OrHash,
|
1585
|
+
Orb::Price::TieredWithMinimum::OrHash,
|
1586
|
+
Orb::Price::TieredPackageWithMinimum::OrHash,
|
1587
|
+
Orb::Price::PackageWithAllocation::OrHash,
|
1588
|
+
Orb::Price::UnitWithPercent::OrHash,
|
1589
|
+
Orb::Price::MatrixWithAllocation::OrHash,
|
1590
|
+
Orb::Price::TieredWithProration::OrHash,
|
1591
|
+
Orb::Price::UnitWithProration::OrHash,
|
1592
|
+
Orb::Price::GroupedAllocation::OrHash,
|
1593
|
+
Orb::Price::GroupedWithProratedMinimum::OrHash,
|
1594
|
+
Orb::Price::GroupedWithMeteredMinimum::OrHash,
|
1595
|
+
Orb::Price::MatrixWithDisplayName::OrHash,
|
1596
|
+
Orb::Price::BulkWithProration::OrHash,
|
1597
|
+
Orb::Price::GroupedTieredPackage::OrHash,
|
1598
|
+
Orb::Price::MaxGroupTieredPackage::OrHash,
|
1599
|
+
Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
|
1600
|
+
Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
|
1601
|
+
Orb::Price::CumulativeGroupedBulk::OrHash
|
1602
|
+
),
|
1399
1603
|
start_date: Time,
|
1400
1604
|
usage_customer_ids: T.nilable(T::Array[String])
|
1401
|
-
)
|
1402
|
-
.returns(T.attached_class)
|
1605
|
+
).returns(T.attached_class)
|
1403
1606
|
end
|
1404
1607
|
def self.new(
|
1405
1608
|
id:,
|
@@ -1438,58 +1641,66 @@ module Orb
|
|
1438
1641
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
1439
1642
|
# this price interval.
|
1440
1643
|
usage_customer_ids:
|
1441
|
-
)
|
1644
|
+
)
|
1645
|
+
end
|
1646
|
+
|
1442
1647
|
sig do
|
1443
|
-
override
|
1444
|
-
|
1445
|
-
|
1446
|
-
|
1447
|
-
|
1448
|
-
|
1449
|
-
|
1450
|
-
|
1451
|
-
|
1452
|
-
|
1453
|
-
T::Array[
|
1648
|
+
override.returns(
|
1649
|
+
{
|
1650
|
+
id: String,
|
1651
|
+
billing_cycle_day: Integer,
|
1652
|
+
current_billing_period_end_date: T.nilable(Time),
|
1653
|
+
current_billing_period_start_date: T.nilable(Time),
|
1654
|
+
end_date: T.nilable(Time),
|
1655
|
+
filter: T.nilable(String),
|
1656
|
+
fixed_fee_quantity_transitions:
|
1657
|
+
T.nilable(
|
1658
|
+
T::Array[
|
1659
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::FixedFeeQuantityTransition
|
1660
|
+
]
|
1454
1661
|
),
|
1455
|
-
|
1456
|
-
|
1457
|
-
Orb::
|
1458
|
-
Orb::
|
1459
|
-
Orb::
|
1460
|
-
Orb::
|
1461
|
-
Orb::
|
1462
|
-
Orb::
|
1463
|
-
Orb::
|
1464
|
-
Orb::
|
1465
|
-
Orb::
|
1466
|
-
Orb::
|
1467
|
-
Orb::
|
1468
|
-
Orb::
|
1469
|
-
Orb::
|
1470
|
-
Orb::
|
1471
|
-
Orb::
|
1472
|
-
Orb::
|
1473
|
-
Orb::
|
1474
|
-
Orb::
|
1475
|
-
Orb::
|
1476
|
-
Orb::
|
1477
|
-
Orb::
|
1478
|
-
Orb::
|
1479
|
-
Orb::
|
1480
|
-
Orb::
|
1481
|
-
Orb::
|
1482
|
-
Orb::
|
1483
|
-
Orb::
|
1662
|
+
price:
|
1663
|
+
T.any(
|
1664
|
+
Orb::Price::Unit,
|
1665
|
+
Orb::Price::Package,
|
1666
|
+
Orb::Price::Matrix,
|
1667
|
+
Orb::Price::Tiered,
|
1668
|
+
Orb::Price::TieredBps,
|
1669
|
+
Orb::Price::Bps,
|
1670
|
+
Orb::Price::BulkBps,
|
1671
|
+
Orb::Price::Bulk,
|
1672
|
+
Orb::Price::ThresholdTotalAmount,
|
1673
|
+
Orb::Price::TieredPackage,
|
1674
|
+
Orb::Price::GroupedTiered,
|
1675
|
+
Orb::Price::TieredWithMinimum,
|
1676
|
+
Orb::Price::TieredPackageWithMinimum,
|
1677
|
+
Orb::Price::PackageWithAllocation,
|
1678
|
+
Orb::Price::UnitWithPercent,
|
1679
|
+
Orb::Price::MatrixWithAllocation,
|
1680
|
+
Orb::Price::TieredWithProration,
|
1681
|
+
Orb::Price::UnitWithProration,
|
1682
|
+
Orb::Price::GroupedAllocation,
|
1683
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1684
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1685
|
+
Orb::Price::MatrixWithDisplayName,
|
1686
|
+
Orb::Price::BulkWithProration,
|
1687
|
+
Orb::Price::GroupedTieredPackage,
|
1688
|
+
Orb::Price::MaxGroupTieredPackage,
|
1689
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1690
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1691
|
+
Orb::Price::CumulativeGroupedBulk
|
1484
1692
|
),
|
1485
|
-
|
1486
|
-
|
1487
|
-
|
1488
|
-
|
1693
|
+
start_date: Time,
|
1694
|
+
usage_customer_ids: T.nilable(T::Array[String])
|
1695
|
+
}
|
1696
|
+
)
|
1697
|
+
end
|
1698
|
+
def to_hash
|
1489
1699
|
end
|
1490
|
-
def to_hash; end
|
1491
1700
|
|
1492
1701
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1702
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1703
|
+
|
1493
1704
|
sig { returns(Time) }
|
1494
1705
|
attr_accessor :effective_date
|
1495
1706
|
|
@@ -1499,15 +1710,29 @@ module Orb
|
|
1499
1710
|
sig { returns(Integer) }
|
1500
1711
|
attr_accessor :quantity
|
1501
1712
|
|
1502
|
-
sig
|
1503
|
-
|
1713
|
+
sig do
|
1714
|
+
params(
|
1715
|
+
effective_date: Time,
|
1716
|
+
price_id: String,
|
1717
|
+
quantity: Integer
|
1718
|
+
).returns(T.attached_class)
|
1719
|
+
end
|
1720
|
+
def self.new(effective_date:, price_id:, quantity:)
|
1721
|
+
end
|
1504
1722
|
|
1505
|
-
sig
|
1506
|
-
|
1723
|
+
sig do
|
1724
|
+
override.returns(
|
1725
|
+
{ effective_date: Time, price_id: String, quantity: Integer }
|
1726
|
+
)
|
1727
|
+
end
|
1728
|
+
def to_hash
|
1729
|
+
end
|
1507
1730
|
end
|
1508
1731
|
end
|
1509
1732
|
|
1510
1733
|
class RedeemedCoupon < Orb::Internal::Type::BaseModel
|
1734
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1735
|
+
|
1511
1736
|
sig { returns(String) }
|
1512
1737
|
attr_accessor :coupon_id
|
1513
1738
|
|
@@ -1518,54 +1743,92 @@ module Orb
|
|
1518
1743
|
attr_accessor :start_date
|
1519
1744
|
|
1520
1745
|
sig do
|
1521
|
-
params(
|
1746
|
+
params(
|
1747
|
+
coupon_id: String,
|
1748
|
+
end_date: T.nilable(Time),
|
1749
|
+
start_date: Time
|
1750
|
+
).returns(T.attached_class)
|
1751
|
+
end
|
1752
|
+
def self.new(coupon_id:, end_date:, start_date:)
|
1522
1753
|
end
|
1523
|
-
def self.new(coupon_id:, end_date:, start_date:); end
|
1524
1754
|
|
1525
|
-
sig
|
1526
|
-
|
1755
|
+
sig do
|
1756
|
+
override.returns(
|
1757
|
+
{ coupon_id: String, end_date: T.nilable(Time), start_date: Time }
|
1758
|
+
)
|
1759
|
+
end
|
1760
|
+
def to_hash
|
1761
|
+
end
|
1527
1762
|
end
|
1528
1763
|
|
1529
1764
|
module Status
|
1530
1765
|
extend Orb::Internal::Type::Enum
|
1531
1766
|
|
1532
|
-
TaggedSymbol =
|
1767
|
+
TaggedSymbol =
|
1768
|
+
T.type_alias do
|
1769
|
+
T.all(Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::Status)
|
1770
|
+
end
|
1533
1771
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1534
1772
|
|
1535
|
-
ACTIVE =
|
1536
|
-
|
1537
|
-
|
1773
|
+
ACTIVE =
|
1774
|
+
T.let(
|
1775
|
+
:active,
|
1776
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol
|
1777
|
+
)
|
1778
|
+
ENDED =
|
1779
|
+
T.let(
|
1780
|
+
:ended,
|
1781
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol
|
1782
|
+
)
|
1783
|
+
UPCOMING =
|
1784
|
+
T.let(
|
1785
|
+
:upcoming,
|
1786
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol
|
1787
|
+
)
|
1538
1788
|
|
1539
|
-
sig
|
1540
|
-
|
1789
|
+
sig do
|
1790
|
+
override.returns(
|
1791
|
+
T::Array[
|
1792
|
+
Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol
|
1793
|
+
]
|
1794
|
+
)
|
1795
|
+
end
|
1796
|
+
def self.values
|
1797
|
+
end
|
1541
1798
|
end
|
1542
1799
|
|
1543
1800
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
1801
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1802
|
+
|
1544
1803
|
sig { returns(T.nilable(Time)) }
|
1545
1804
|
attr_accessor :end_date
|
1546
1805
|
|
1547
1806
|
sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
|
1548
|
-
def self.new(end_date:)
|
1807
|
+
def self.new(end_date:)
|
1808
|
+
end
|
1549
1809
|
|
1550
|
-
sig { override.returns({end_date: T.nilable(Time)}) }
|
1551
|
-
def to_hash
|
1810
|
+
sig { override.returns({ end_date: T.nilable(Time) }) }
|
1811
|
+
def to_hash
|
1812
|
+
end
|
1552
1813
|
end
|
1553
1814
|
|
1554
1815
|
class ChangedResources < Orb::Internal::Type::BaseModel
|
1816
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1817
|
+
|
1555
1818
|
# The credit notes that were created as part of this operation.
|
1556
|
-
sig { returns(T::Array[Orb::
|
1819
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1557
1820
|
attr_accessor :created_credit_notes
|
1558
1821
|
|
1559
1822
|
# The invoices that were created as part of this operation.
|
1560
|
-
sig { returns(T::Array[Orb::
|
1823
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1561
1824
|
attr_accessor :created_invoices
|
1562
1825
|
|
1563
1826
|
# The credit notes that were voided as part of this operation.
|
1564
|
-
sig { returns(T::Array[Orb::
|
1827
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1565
1828
|
attr_accessor :voided_credit_notes
|
1566
1829
|
|
1567
1830
|
# The invoices that were voided as part of this operation.
|
1568
|
-
sig { returns(T::Array[Orb::
|
1831
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1569
1832
|
attr_accessor :voided_invoices
|
1570
1833
|
|
1571
1834
|
# The resources that were changed as part of this operation. Only present when
|
@@ -1573,12 +1836,11 @@ module Orb
|
|
1573
1836
|
# `include_changed_resources` parameter was passed in the request.
|
1574
1837
|
sig do
|
1575
1838
|
params(
|
1576
|
-
created_credit_notes: T::Array[
|
1577
|
-
created_invoices: T::Array[
|
1578
|
-
voided_credit_notes: T::Array[
|
1579
|
-
voided_invoices: T::Array[
|
1580
|
-
)
|
1581
|
-
.returns(T.attached_class)
|
1839
|
+
created_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1840
|
+
created_invoices: T::Array[Orb::Invoice::OrHash],
|
1841
|
+
voided_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1842
|
+
voided_invoices: T::Array[Orb::Invoice::OrHash]
|
1843
|
+
).returns(T.attached_class)
|
1582
1844
|
end
|
1583
1845
|
def self.new(
|
1584
1846
|
# The credit notes that were created as part of this operation.
|
@@ -1589,19 +1851,21 @@ module Orb
|
|
1589
1851
|
voided_credit_notes:,
|
1590
1852
|
# The invoices that were voided as part of this operation.
|
1591
1853
|
voided_invoices:
|
1592
|
-
)
|
1854
|
+
)
|
1855
|
+
end
|
1856
|
+
|
1593
1857
|
sig do
|
1594
|
-
override
|
1595
|
-
|
1596
|
-
|
1597
|
-
|
1598
|
-
|
1599
|
-
|
1600
|
-
|
1601
|
-
|
1602
|
-
|
1858
|
+
override.returns(
|
1859
|
+
{
|
1860
|
+
created_credit_notes: T::Array[Orb::CreditNote],
|
1861
|
+
created_invoices: T::Array[Orb::Invoice],
|
1862
|
+
voided_credit_notes: T::Array[Orb::CreditNote],
|
1863
|
+
voided_invoices: T::Array[Orb::Invoice]
|
1864
|
+
}
|
1865
|
+
)
|
1866
|
+
end
|
1867
|
+
def to_hash
|
1603
1868
|
end
|
1604
|
-
def to_hash; end
|
1605
1869
|
end
|
1606
1870
|
end
|
1607
1871
|
end
|