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 SubscriptionChangeRetrieveResponse < 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
|
|
@@ -10,17 +12,29 @@ module Orb
|
|
10
12
|
sig { returns(Time) }
|
11
13
|
attr_accessor :expiration_time
|
12
14
|
|
13
|
-
sig
|
15
|
+
sig do
|
16
|
+
returns(
|
17
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol
|
18
|
+
)
|
19
|
+
end
|
14
20
|
attr_accessor :status
|
15
21
|
|
16
|
-
sig
|
22
|
+
sig do
|
23
|
+
returns(
|
24
|
+
T.nilable(
|
25
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription
|
26
|
+
)
|
27
|
+
)
|
28
|
+
end
|
17
29
|
attr_reader :subscription
|
18
30
|
|
19
31
|
sig do
|
20
32
|
params(
|
21
|
-
subscription:
|
22
|
-
|
23
|
-
|
33
|
+
subscription:
|
34
|
+
T.nilable(
|
35
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::OrHash
|
36
|
+
)
|
37
|
+
).void
|
24
38
|
end
|
25
39
|
attr_writer :subscription
|
26
40
|
|
@@ -40,12 +54,15 @@ module Orb
|
|
40
54
|
params(
|
41
55
|
id: String,
|
42
56
|
expiration_time: Time,
|
43
|
-
status:
|
44
|
-
|
57
|
+
status:
|
58
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Status::OrSymbol,
|
59
|
+
subscription:
|
60
|
+
T.nilable(
|
61
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::OrHash
|
62
|
+
),
|
45
63
|
applied_at: T.nilable(Time),
|
46
64
|
cancelled_at: T.nilable(Time)
|
47
|
-
)
|
48
|
-
.returns(T.attached_class)
|
65
|
+
).returns(T.attached_class)
|
49
66
|
end
|
50
67
|
def self.new(
|
51
68
|
id:,
|
@@ -57,37 +74,70 @@ module Orb
|
|
57
74
|
applied_at: nil,
|
58
75
|
# When this change was cancelled.
|
59
76
|
cancelled_at: nil
|
60
|
-
)
|
77
|
+
)
|
78
|
+
end
|
79
|
+
|
61
80
|
sig do
|
62
|
-
override
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
81
|
+
override.returns(
|
82
|
+
{
|
83
|
+
id: String,
|
84
|
+
expiration_time: Time,
|
85
|
+
status:
|
86
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol,
|
87
|
+
subscription:
|
88
|
+
T.nilable(
|
89
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription
|
90
|
+
),
|
91
|
+
applied_at: T.nilable(Time),
|
92
|
+
cancelled_at: T.nilable(Time)
|
93
|
+
}
|
94
|
+
)
|
95
|
+
end
|
96
|
+
def to_hash
|
73
97
|
end
|
74
|
-
def to_hash; end
|
75
98
|
|
76
99
|
module Status
|
77
100
|
extend Orb::Internal::Type::Enum
|
78
101
|
|
79
|
-
TaggedSymbol =
|
102
|
+
TaggedSymbol =
|
103
|
+
T.type_alias do
|
104
|
+
T.all(
|
105
|
+
Symbol,
|
106
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Status
|
107
|
+
)
|
108
|
+
end
|
80
109
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
81
110
|
|
82
|
-
PENDING =
|
83
|
-
|
84
|
-
|
111
|
+
PENDING =
|
112
|
+
T.let(
|
113
|
+
:pending,
|
114
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol
|
115
|
+
)
|
116
|
+
APPLIED =
|
117
|
+
T.let(
|
118
|
+
:applied,
|
119
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol
|
120
|
+
)
|
121
|
+
CANCELLED =
|
122
|
+
T.let(
|
123
|
+
:cancelled,
|
124
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol
|
125
|
+
)
|
85
126
|
|
86
|
-
sig
|
87
|
-
|
127
|
+
sig do
|
128
|
+
override.returns(
|
129
|
+
T::Array[
|
130
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol
|
131
|
+
]
|
132
|
+
)
|
133
|
+
end
|
134
|
+
def self.values
|
135
|
+
end
|
88
136
|
end
|
89
137
|
|
90
138
|
class Subscription < Orb::Internal::Type::BaseModel
|
139
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
140
|
+
|
91
141
|
sig { returns(String) }
|
92
142
|
attr_accessor :id
|
93
143
|
|
@@ -98,7 +148,13 @@ module Orb
|
|
98
148
|
|
99
149
|
# The adjustment intervals for this subscription sorted by the start_date of the
|
100
150
|
# adjustment interval.
|
101
|
-
sig
|
151
|
+
sig do
|
152
|
+
returns(
|
153
|
+
T::Array[
|
154
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval
|
155
|
+
]
|
156
|
+
)
|
157
|
+
end
|
102
158
|
attr_accessor :adjustment_intervals
|
103
159
|
|
104
160
|
# Determines whether issued invoices for this subscription will automatically be
|
@@ -107,17 +163,18 @@ module Orb
|
|
107
163
|
sig { returns(T.nilable(T::Boolean)) }
|
108
164
|
attr_accessor :auto_collection
|
109
165
|
|
110
|
-
sig
|
166
|
+
sig do
|
167
|
+
returns(
|
168
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration
|
169
|
+
)
|
170
|
+
end
|
111
171
|
attr_reader :billing_cycle_anchor_configuration
|
112
172
|
|
113
173
|
sig do
|
114
174
|
params(
|
115
|
-
billing_cycle_anchor_configuration:
|
116
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration
|
117
|
-
|
118
|
-
)
|
119
|
-
)
|
120
|
-
.void
|
175
|
+
billing_cycle_anchor_configuration:
|
176
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration::OrHash
|
177
|
+
).void
|
121
178
|
end
|
122
179
|
attr_writer :billing_cycle_anchor_configuration
|
123
180
|
|
@@ -161,10 +218,10 @@ module Orb
|
|
161
218
|
# [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
162
219
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
163
220
|
# information on what this timezone parameter influences within Orb.
|
164
|
-
sig { returns(Orb::
|
221
|
+
sig { returns(Orb::Customer) }
|
165
222
|
attr_reader :customer
|
166
223
|
|
167
|
-
sig { params(customer:
|
224
|
+
sig { params(customer: Orb::Customer::OrHash).void }
|
168
225
|
attr_writer :customer
|
169
226
|
|
170
227
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
@@ -190,14 +247,26 @@ module Orb
|
|
190
247
|
sig { returns(T.nilable(Time)) }
|
191
248
|
attr_accessor :end_date
|
192
249
|
|
193
|
-
sig
|
250
|
+
sig do
|
251
|
+
returns(
|
252
|
+
T::Array[
|
253
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule
|
254
|
+
]
|
255
|
+
)
|
256
|
+
end
|
194
257
|
attr_accessor :fixed_fee_quantity_schedule
|
195
258
|
|
196
259
|
sig { returns(T.nilable(String)) }
|
197
260
|
attr_accessor :invoicing_threshold
|
198
261
|
|
199
262
|
# The maximum intervals for this subscription sorted by the start_date.
|
200
|
-
sig
|
263
|
+
sig do
|
264
|
+
returns(
|
265
|
+
T::Array[
|
266
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval
|
267
|
+
]
|
268
|
+
)
|
269
|
+
end
|
201
270
|
attr_accessor :maximum_intervals
|
202
271
|
|
203
272
|
# User specified key-value pairs for the resource. If not present, this defaults
|
@@ -208,7 +277,13 @@ module Orb
|
|
208
277
|
attr_accessor :metadata
|
209
278
|
|
210
279
|
# The minimum intervals for this subscription sorted by the start_date.
|
211
|
-
sig
|
280
|
+
sig do
|
281
|
+
returns(
|
282
|
+
T::Array[
|
283
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval
|
284
|
+
]
|
285
|
+
)
|
286
|
+
end
|
212
287
|
attr_accessor :minimum_intervals
|
213
288
|
|
214
289
|
# Determines the difference between the invoice issue date for subscription
|
@@ -221,21 +296,20 @@ module Orb
|
|
221
296
|
# A pending subscription change if one exists on this subscription.
|
222
297
|
sig do
|
223
298
|
returns(
|
224
|
-
T.nilable(
|
299
|
+
T.nilable(
|
300
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange
|
301
|
+
)
|
225
302
|
)
|
226
303
|
end
|
227
304
|
attr_reader :pending_subscription_change
|
228
305
|
|
229
306
|
sig do
|
230
307
|
params(
|
231
|
-
pending_subscription_change:
|
232
|
-
T.
|
233
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange
|
234
|
-
Orb::Internal::AnyHash
|
308
|
+
pending_subscription_change:
|
309
|
+
T.nilable(
|
310
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange::OrHash
|
235
311
|
)
|
236
|
-
|
237
|
-
)
|
238
|
-
.void
|
312
|
+
).void
|
239
313
|
end
|
240
314
|
attr_writer :pending_subscription_change
|
241
315
|
|
@@ -243,29 +317,38 @@ module Orb
|
|
243
317
|
# subscribed to by a customer. Plans define the billing behavior of the
|
244
318
|
# subscription. You can see more about how to configure prices in the
|
245
319
|
# [Price resource](/reference/price).
|
246
|
-
sig { returns(Orb::
|
320
|
+
sig { returns(Orb::Plan) }
|
247
321
|
attr_reader :plan
|
248
322
|
|
249
|
-
sig { params(plan:
|
323
|
+
sig { params(plan: Orb::Plan::OrHash).void }
|
250
324
|
attr_writer :plan
|
251
325
|
|
252
326
|
# The price intervals for this subscription.
|
253
|
-
sig
|
327
|
+
sig do
|
328
|
+
returns(
|
329
|
+
T::Array[
|
330
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval
|
331
|
+
]
|
332
|
+
)
|
333
|
+
end
|
254
334
|
attr_accessor :price_intervals
|
255
335
|
|
256
|
-
sig
|
336
|
+
sig do
|
337
|
+
returns(
|
338
|
+
T.nilable(
|
339
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon
|
340
|
+
)
|
341
|
+
)
|
342
|
+
end
|
257
343
|
attr_reader :redeemed_coupon
|
258
344
|
|
259
345
|
sig do
|
260
346
|
params(
|
261
|
-
redeemed_coupon:
|
262
|
-
T.
|
263
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon
|
264
|
-
Orb::Internal::AnyHash
|
347
|
+
redeemed_coupon:
|
348
|
+
T.nilable(
|
349
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon::OrHash
|
265
350
|
)
|
266
|
-
|
267
|
-
)
|
268
|
-
.void
|
351
|
+
).void
|
269
352
|
end
|
270
353
|
attr_writer :redeemed_coupon
|
271
354
|
|
@@ -273,36 +356,47 @@ module Orb
|
|
273
356
|
sig { returns(Time) }
|
274
357
|
attr_accessor :start_date
|
275
358
|
|
276
|
-
sig
|
359
|
+
sig do
|
360
|
+
returns(
|
361
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol
|
362
|
+
)
|
363
|
+
end
|
277
364
|
attr_accessor :status
|
278
365
|
|
279
|
-
sig
|
366
|
+
sig do
|
367
|
+
returns(
|
368
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo
|
369
|
+
)
|
370
|
+
end
|
280
371
|
attr_reader :trial_info
|
281
372
|
|
282
373
|
sig do
|
283
374
|
params(
|
284
|
-
trial_info:
|
285
|
-
|
286
|
-
|
375
|
+
trial_info:
|
376
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo::OrHash
|
377
|
+
).void
|
287
378
|
end
|
288
379
|
attr_writer :trial_info
|
289
380
|
|
290
381
|
# The resources that were changed as part of this operation. Only present when
|
291
382
|
# fetched through the subscription changes API or if the
|
292
383
|
# `include_changed_resources` parameter was passed in the request.
|
293
|
-
sig
|
384
|
+
sig do
|
385
|
+
returns(
|
386
|
+
T.nilable(
|
387
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources
|
388
|
+
)
|
389
|
+
)
|
390
|
+
end
|
294
391
|
attr_reader :changed_resources
|
295
392
|
|
296
393
|
sig do
|
297
394
|
params(
|
298
|
-
changed_resources:
|
299
|
-
T.
|
300
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources
|
301
|
-
Orb::Internal::AnyHash
|
395
|
+
changed_resources:
|
396
|
+
T.nilable(
|
397
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources::OrHash
|
302
398
|
)
|
303
|
-
|
304
|
-
)
|
305
|
-
.void
|
399
|
+
).void
|
306
400
|
end
|
307
401
|
attr_writer :changed_resources
|
308
402
|
|
@@ -310,83 +404,66 @@ module Orb
|
|
310
404
|
params(
|
311
405
|
id: String,
|
312
406
|
active_plan_phase_order: T.nilable(Integer),
|
313
|
-
adjustment_intervals:
|
314
|
-
T
|
315
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval
|
316
|
-
|
317
|
-
)
|
318
|
-
],
|
407
|
+
adjustment_intervals:
|
408
|
+
T::Array[
|
409
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::OrHash
|
410
|
+
],
|
319
411
|
auto_collection: T.nilable(T::Boolean),
|
320
|
-
billing_cycle_anchor_configuration:
|
321
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration,
|
322
|
-
Orb::Internal::AnyHash
|
323
|
-
),
|
412
|
+
billing_cycle_anchor_configuration:
|
413
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration::OrHash,
|
324
414
|
billing_cycle_day: Integer,
|
325
415
|
created_at: Time,
|
326
416
|
current_billing_period_end_date: T.nilable(Time),
|
327
417
|
current_billing_period_start_date: T.nilable(Time),
|
328
|
-
customer:
|
418
|
+
customer: Orb::Customer::OrHash,
|
329
419
|
default_invoice_memo: T.nilable(String),
|
330
|
-
discount_intervals:
|
331
|
-
T
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
420
|
+
discount_intervals:
|
421
|
+
T::Array[
|
422
|
+
T.any(
|
423
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Amount::OrHash,
|
424
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Percentage::OrHash,
|
425
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Usage::OrHash
|
426
|
+
)
|
427
|
+
],
|
338
428
|
end_date: T.nilable(Time),
|
339
|
-
fixed_fee_quantity_schedule:
|
340
|
-
T
|
341
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule
|
342
|
-
|
343
|
-
)
|
344
|
-
],
|
429
|
+
fixed_fee_quantity_schedule:
|
430
|
+
T::Array[
|
431
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule::OrHash
|
432
|
+
],
|
345
433
|
invoicing_threshold: T.nilable(String),
|
346
|
-
maximum_intervals:
|
347
|
-
T
|
348
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval
|
349
|
-
|
350
|
-
)
|
351
|
-
],
|
434
|
+
maximum_intervals:
|
435
|
+
T::Array[
|
436
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval::OrHash
|
437
|
+
],
|
352
438
|
metadata: T::Hash[Symbol, String],
|
353
|
-
minimum_intervals:
|
354
|
-
T
|
355
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval
|
356
|
-
|
357
|
-
)
|
358
|
-
],
|
439
|
+
minimum_intervals:
|
440
|
+
T::Array[
|
441
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval::OrHash
|
442
|
+
],
|
359
443
|
net_terms: Integer,
|
360
|
-
pending_subscription_change:
|
361
|
-
T.
|
362
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
redeemed_coupon: T.nilable(
|
374
|
-
T.any(
|
375
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon,
|
376
|
-
Orb::Internal::AnyHash
|
377
|
-
)
|
378
|
-
),
|
444
|
+
pending_subscription_change:
|
445
|
+
T.nilable(
|
446
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange::OrHash
|
447
|
+
),
|
448
|
+
plan: Orb::Plan::OrHash,
|
449
|
+
price_intervals:
|
450
|
+
T::Array[
|
451
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::OrHash
|
452
|
+
],
|
453
|
+
redeemed_coupon:
|
454
|
+
T.nilable(
|
455
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon::OrHash
|
456
|
+
),
|
379
457
|
start_date: Time,
|
380
|
-
status:
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
458
|
+
status:
|
459
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::OrSymbol,
|
460
|
+
trial_info:
|
461
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo::OrHash,
|
462
|
+
changed_resources:
|
463
|
+
T.nilable(
|
464
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources::OrHash
|
386
465
|
)
|
387
|
-
|
388
|
-
)
|
389
|
-
.returns(T.attached_class)
|
466
|
+
).returns(T.attached_class)
|
390
467
|
end
|
391
468
|
def self.new(
|
392
469
|
id:,
|
@@ -475,50 +552,82 @@ module Orb
|
|
475
552
|
# fetched through the subscription changes API or if the
|
476
553
|
# `include_changed_resources` parameter was passed in the request.
|
477
554
|
changed_resources: nil
|
478
|
-
)
|
555
|
+
)
|
556
|
+
end
|
557
|
+
|
479
558
|
sig do
|
480
|
-
override
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
559
|
+
override.returns(
|
560
|
+
{
|
561
|
+
id: String,
|
562
|
+
active_plan_phase_order: T.nilable(Integer),
|
563
|
+
adjustment_intervals:
|
564
|
+
T::Array[
|
565
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval
|
566
|
+
],
|
567
|
+
auto_collection: T.nilable(T::Boolean),
|
568
|
+
billing_cycle_anchor_configuration:
|
569
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration,
|
570
|
+
billing_cycle_day: Integer,
|
571
|
+
created_at: Time,
|
572
|
+
current_billing_period_end_date: T.nilable(Time),
|
573
|
+
current_billing_period_start_date: T.nilable(Time),
|
574
|
+
customer: Orb::Customer,
|
575
|
+
default_invoice_memo: T.nilable(String),
|
576
|
+
discount_intervals:
|
577
|
+
T::Array[
|
495
578
|
T.any(
|
496
579
|
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Amount,
|
497
580
|
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Percentage,
|
498
581
|
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Usage
|
499
582
|
)
|
500
583
|
],
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
584
|
+
end_date: T.nilable(Time),
|
585
|
+
fixed_fee_quantity_schedule:
|
586
|
+
T::Array[
|
587
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule
|
588
|
+
],
|
589
|
+
invoicing_threshold: T.nilable(String),
|
590
|
+
maximum_intervals:
|
591
|
+
T::Array[
|
592
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval
|
593
|
+
],
|
594
|
+
metadata: T::Hash[Symbol, String],
|
595
|
+
minimum_intervals:
|
596
|
+
T::Array[
|
597
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval
|
598
|
+
],
|
599
|
+
net_terms: Integer,
|
600
|
+
pending_subscription_change:
|
601
|
+
T.nilable(
|
602
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange
|
603
|
+
),
|
604
|
+
plan: Orb::Plan,
|
605
|
+
price_intervals:
|
606
|
+
T::Array[
|
607
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval
|
608
|
+
],
|
609
|
+
redeemed_coupon:
|
610
|
+
T.nilable(
|
611
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon
|
612
|
+
),
|
613
|
+
start_date: Time,
|
614
|
+
status:
|
615
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol,
|
616
|
+
trial_info:
|
617
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo,
|
618
|
+
changed_resources:
|
619
|
+
T.nilable(
|
620
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources
|
621
|
+
)
|
622
|
+
}
|
623
|
+
)
|
624
|
+
end
|
625
|
+
def to_hash
|
518
626
|
end
|
519
|
-
def to_hash; end
|
520
627
|
|
521
628
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
629
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
630
|
+
|
522
631
|
sig { returns(String) }
|
523
632
|
attr_accessor :id
|
524
633
|
|
@@ -550,19 +659,18 @@ module Orb
|
|
550
659
|
sig do
|
551
660
|
params(
|
552
661
|
id: String,
|
553
|
-
adjustment:
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
662
|
+
adjustment:
|
663
|
+
T.any(
|
664
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::OrHash,
|
665
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::OrHash,
|
666
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::OrHash,
|
667
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Minimum::OrHash,
|
668
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Maximum::OrHash
|
669
|
+
),
|
561
670
|
applies_to_price_interval_ids: T::Array[String],
|
562
671
|
end_date: T.nilable(Time),
|
563
672
|
start_date: Time
|
564
|
-
)
|
565
|
-
.returns(T.attached_class)
|
673
|
+
).returns(T.attached_class)
|
566
674
|
end
|
567
675
|
def self.new(
|
568
676
|
id:,
|
@@ -573,31 +681,48 @@ module Orb
|
|
573
681
|
end_date:,
|
574
682
|
# The start date of the adjustment interval.
|
575
683
|
start_date:
|
576
|
-
)
|
684
|
+
)
|
685
|
+
end
|
686
|
+
|
577
687
|
sig do
|
578
|
-
override
|
579
|
-
|
580
|
-
|
581
|
-
|
582
|
-
|
688
|
+
override.returns(
|
689
|
+
{
|
690
|
+
id: String,
|
691
|
+
adjustment:
|
692
|
+
T.any(
|
583
693
|
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
|
584
694
|
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
|
585
695
|
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
|
586
696
|
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Minimum,
|
587
697
|
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Maximum
|
588
698
|
),
|
589
|
-
|
590
|
-
|
591
|
-
|
592
|
-
|
593
|
-
|
699
|
+
applies_to_price_interval_ids: T::Array[String],
|
700
|
+
end_date: T.nilable(Time),
|
701
|
+
start_date: Time
|
702
|
+
}
|
703
|
+
)
|
704
|
+
end
|
705
|
+
def to_hash
|
594
706
|
end
|
595
|
-
def to_hash; end
|
596
707
|
|
597
708
|
module Adjustment
|
598
709
|
extend Orb::Internal::Type::Union
|
599
710
|
|
711
|
+
Variants =
|
712
|
+
T.type_alias do
|
713
|
+
T.any(
|
714
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
|
715
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
|
716
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
|
717
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Minimum,
|
718
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Maximum
|
719
|
+
)
|
720
|
+
end
|
721
|
+
|
600
722
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
723
|
+
OrHash =
|
724
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
725
|
+
|
601
726
|
sig { returns(String) }
|
602
727
|
attr_accessor :id
|
603
728
|
|
@@ -635,8 +760,7 @@ module Orb
|
|
635
760
|
reason: T.nilable(String),
|
636
761
|
usage_discount: Float,
|
637
762
|
adjustment_type: Symbol
|
638
|
-
)
|
639
|
-
.returns(T.attached_class)
|
763
|
+
).returns(T.attached_class)
|
640
764
|
end
|
641
765
|
def self.new(
|
642
766
|
id:,
|
@@ -653,25 +777,30 @@ module Orb
|
|
653
777
|
# to in a given billing period.
|
654
778
|
usage_discount:,
|
655
779
|
adjustment_type: :usage_discount
|
656
|
-
)
|
780
|
+
)
|
781
|
+
end
|
782
|
+
|
657
783
|
sig do
|
658
|
-
override
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
666
|
-
|
667
|
-
|
668
|
-
|
669
|
-
|
784
|
+
override.returns(
|
785
|
+
{
|
786
|
+
id: String,
|
787
|
+
adjustment_type: Symbol,
|
788
|
+
applies_to_price_ids: T::Array[String],
|
789
|
+
is_invoice_level: T::Boolean,
|
790
|
+
plan_phase_order: T.nilable(Integer),
|
791
|
+
reason: T.nilable(String),
|
792
|
+
usage_discount: Float
|
793
|
+
}
|
794
|
+
)
|
795
|
+
end
|
796
|
+
def to_hash
|
670
797
|
end
|
671
|
-
def to_hash; end
|
672
798
|
end
|
673
799
|
|
674
800
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
801
|
+
OrHash =
|
802
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
803
|
+
|
675
804
|
sig { returns(String) }
|
676
805
|
attr_accessor :id
|
677
806
|
|
@@ -709,8 +838,7 @@ module Orb
|
|
709
838
|
plan_phase_order: T.nilable(Integer),
|
710
839
|
reason: T.nilable(String),
|
711
840
|
adjustment_type: Symbol
|
712
|
-
)
|
713
|
-
.returns(T.attached_class)
|
841
|
+
).returns(T.attached_class)
|
714
842
|
end
|
715
843
|
def self.new(
|
716
844
|
id:,
|
@@ -727,25 +855,30 @@ module Orb
|
|
727
855
|
# The reason for the adjustment.
|
728
856
|
reason:,
|
729
857
|
adjustment_type: :amount_discount
|
730
|
-
)
|
858
|
+
)
|
859
|
+
end
|
860
|
+
|
731
861
|
sig do
|
732
|
-
override
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
862
|
+
override.returns(
|
863
|
+
{
|
864
|
+
id: String,
|
865
|
+
adjustment_type: Symbol,
|
866
|
+
amount_discount: String,
|
867
|
+
applies_to_price_ids: T::Array[String],
|
868
|
+
is_invoice_level: T::Boolean,
|
869
|
+
plan_phase_order: T.nilable(Integer),
|
870
|
+
reason: T.nilable(String)
|
871
|
+
}
|
872
|
+
)
|
873
|
+
end
|
874
|
+
def to_hash
|
744
875
|
end
|
745
|
-
def to_hash; end
|
746
876
|
end
|
747
877
|
|
748
878
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
879
|
+
OrHash =
|
880
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
881
|
+
|
749
882
|
sig { returns(String) }
|
750
883
|
attr_accessor :id
|
751
884
|
|
@@ -783,8 +916,7 @@ module Orb
|
|
783
916
|
plan_phase_order: T.nilable(Integer),
|
784
917
|
reason: T.nilable(String),
|
785
918
|
adjustment_type: Symbol
|
786
|
-
)
|
787
|
-
.returns(T.attached_class)
|
919
|
+
).returns(T.attached_class)
|
788
920
|
end
|
789
921
|
def self.new(
|
790
922
|
id:,
|
@@ -801,25 +933,30 @@ module Orb
|
|
801
933
|
# The reason for the adjustment.
|
802
934
|
reason:,
|
803
935
|
adjustment_type: :percentage_discount
|
804
|
-
)
|
936
|
+
)
|
937
|
+
end
|
938
|
+
|
805
939
|
sig do
|
806
|
-
override
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
940
|
+
override.returns(
|
941
|
+
{
|
942
|
+
id: String,
|
943
|
+
adjustment_type: Symbol,
|
944
|
+
applies_to_price_ids: T::Array[String],
|
945
|
+
is_invoice_level: T::Boolean,
|
946
|
+
percentage_discount: Float,
|
947
|
+
plan_phase_order: T.nilable(Integer),
|
948
|
+
reason: T.nilable(String)
|
949
|
+
}
|
950
|
+
)
|
951
|
+
end
|
952
|
+
def to_hash
|
818
953
|
end
|
819
|
-
def to_hash; end
|
820
954
|
end
|
821
955
|
|
822
956
|
class Minimum < Orb::Internal::Type::BaseModel
|
957
|
+
OrHash =
|
958
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
959
|
+
|
823
960
|
sig { returns(String) }
|
824
961
|
attr_accessor :id
|
825
962
|
|
@@ -862,8 +999,7 @@ module Orb
|
|
862
999
|
plan_phase_order: T.nilable(Integer),
|
863
1000
|
reason: T.nilable(String),
|
864
1001
|
adjustment_type: Symbol
|
865
|
-
)
|
866
|
-
.returns(T.attached_class)
|
1002
|
+
).returns(T.attached_class)
|
867
1003
|
end
|
868
1004
|
def self.new(
|
869
1005
|
id:,
|
@@ -882,26 +1018,31 @@ module Orb
|
|
882
1018
|
# The reason for the adjustment.
|
883
1019
|
reason:,
|
884
1020
|
adjustment_type: :minimum
|
885
|
-
)
|
1021
|
+
)
|
1022
|
+
end
|
1023
|
+
|
886
1024
|
sig do
|
887
|
-
override
|
888
|
-
|
889
|
-
|
890
|
-
|
891
|
-
|
892
|
-
|
893
|
-
|
894
|
-
|
895
|
-
|
896
|
-
|
897
|
-
|
898
|
-
|
899
|
-
|
1025
|
+
override.returns(
|
1026
|
+
{
|
1027
|
+
id: String,
|
1028
|
+
adjustment_type: Symbol,
|
1029
|
+
applies_to_price_ids: T::Array[String],
|
1030
|
+
is_invoice_level: T::Boolean,
|
1031
|
+
item_id: String,
|
1032
|
+
minimum_amount: String,
|
1033
|
+
plan_phase_order: T.nilable(Integer),
|
1034
|
+
reason: T.nilable(String)
|
1035
|
+
}
|
1036
|
+
)
|
1037
|
+
end
|
1038
|
+
def to_hash
|
900
1039
|
end
|
901
|
-
def to_hash; end
|
902
1040
|
end
|
903
1041
|
|
904
1042
|
class Maximum < Orb::Internal::Type::BaseModel
|
1043
|
+
OrHash =
|
1044
|
+
T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1045
|
+
|
905
1046
|
sig { returns(String) }
|
906
1047
|
attr_accessor :id
|
907
1048
|
|
@@ -939,8 +1080,7 @@ module Orb
|
|
939
1080
|
plan_phase_order: T.nilable(Integer),
|
940
1081
|
reason: T.nilable(String),
|
941
1082
|
adjustment_type: Symbol
|
942
|
-
)
|
943
|
-
.returns(T.attached_class)
|
1083
|
+
).returns(T.attached_class)
|
944
1084
|
end
|
945
1085
|
def self.new(
|
946
1086
|
id:,
|
@@ -957,35 +1097,41 @@ module Orb
|
|
957
1097
|
# The reason for the adjustment.
|
958
1098
|
reason:,
|
959
1099
|
adjustment_type: :maximum
|
960
|
-
)
|
1100
|
+
)
|
1101
|
+
end
|
1102
|
+
|
961
1103
|
sig do
|
962
|
-
override
|
963
|
-
|
964
|
-
|
965
|
-
|
966
|
-
|
967
|
-
|
968
|
-
|
969
|
-
|
970
|
-
|
971
|
-
|
972
|
-
|
973
|
-
|
1104
|
+
override.returns(
|
1105
|
+
{
|
1106
|
+
id: String,
|
1107
|
+
adjustment_type: Symbol,
|
1108
|
+
applies_to_price_ids: T::Array[String],
|
1109
|
+
is_invoice_level: T::Boolean,
|
1110
|
+
maximum_amount: String,
|
1111
|
+
plan_phase_order: T.nilable(Integer),
|
1112
|
+
reason: T.nilable(String)
|
1113
|
+
}
|
1114
|
+
)
|
1115
|
+
end
|
1116
|
+
def to_hash
|
974
1117
|
end
|
975
|
-
def to_hash; end
|
976
1118
|
end
|
977
1119
|
|
978
1120
|
sig do
|
979
|
-
override
|
980
|
-
|
981
|
-
|
982
|
-
|
1121
|
+
override.returns(
|
1122
|
+
T::Array[
|
1123
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Variants
|
1124
|
+
]
|
1125
|
+
)
|
1126
|
+
end
|
1127
|
+
def self.variants
|
983
1128
|
end
|
984
|
-
def self.variants; end
|
985
1129
|
end
|
986
1130
|
end
|
987
1131
|
|
988
1132
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
1133
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1134
|
+
|
989
1135
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
990
1136
|
# number of days in a month is greater than this value, the last day of the month
|
991
1137
|
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
@@ -1024,15 +1170,37 @@ module Orb
|
|
1024
1170
|
# The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
1025
1171
|
# anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
1026
1172
|
year: nil
|
1027
|
-
)
|
1028
|
-
|
1029
|
-
|
1173
|
+
)
|
1174
|
+
end
|
1175
|
+
|
1176
|
+
sig do
|
1177
|
+
override.returns(
|
1178
|
+
{
|
1179
|
+
day: Integer,
|
1180
|
+
month: T.nilable(Integer),
|
1181
|
+
year: T.nilable(Integer)
|
1182
|
+
}
|
1183
|
+
)
|
1184
|
+
end
|
1185
|
+
def to_hash
|
1186
|
+
end
|
1030
1187
|
end
|
1031
1188
|
|
1032
1189
|
module DiscountInterval
|
1033
1190
|
extend Orb::Internal::Type::Union
|
1034
1191
|
|
1192
|
+
Variants =
|
1193
|
+
T.type_alias do
|
1194
|
+
T.any(
|
1195
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Amount,
|
1196
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Percentage,
|
1197
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Usage
|
1198
|
+
)
|
1199
|
+
end
|
1200
|
+
|
1035
1201
|
class Amount < Orb::Internal::Type::BaseModel
|
1202
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1203
|
+
|
1036
1204
|
# Only available if discount_type is `amount`.
|
1037
1205
|
sig { returns(String) }
|
1038
1206
|
attr_accessor :amount_discount
|
@@ -1064,8 +1232,7 @@ module Orb
|
|
1064
1232
|
end_date: T.nilable(Time),
|
1065
1233
|
start_date: Time,
|
1066
1234
|
discount_type: Symbol
|
1067
|
-
)
|
1068
|
-
.returns(T.attached_class)
|
1235
|
+
).returns(T.attached_class)
|
1069
1236
|
end
|
1070
1237
|
def self.new(
|
1071
1238
|
# Only available if discount_type is `amount`.
|
@@ -1079,24 +1246,28 @@ module Orb
|
|
1079
1246
|
# The start date of the discount interval.
|
1080
1247
|
start_date:,
|
1081
1248
|
discount_type: :amount
|
1082
|
-
)
|
1249
|
+
)
|
1250
|
+
end
|
1251
|
+
|
1083
1252
|
sig do
|
1084
|
-
override
|
1085
|
-
|
1086
|
-
|
1087
|
-
|
1088
|
-
|
1089
|
-
|
1090
|
-
|
1091
|
-
|
1092
|
-
|
1093
|
-
|
1094
|
-
|
1253
|
+
override.returns(
|
1254
|
+
{
|
1255
|
+
amount_discount: String,
|
1256
|
+
applies_to_price_ids: T::Array[String],
|
1257
|
+
applies_to_price_interval_ids: T::Array[String],
|
1258
|
+
discount_type: Symbol,
|
1259
|
+
end_date: T.nilable(Time),
|
1260
|
+
start_date: Time
|
1261
|
+
}
|
1262
|
+
)
|
1263
|
+
end
|
1264
|
+
def to_hash
|
1095
1265
|
end
|
1096
|
-
def to_hash; end
|
1097
1266
|
end
|
1098
1267
|
|
1099
1268
|
class Percentage < Orb::Internal::Type::BaseModel
|
1269
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1270
|
+
|
1100
1271
|
# The price ids that this discount interval applies to.
|
1101
1272
|
sig { returns(T::Array[String]) }
|
1102
1273
|
attr_accessor :applies_to_price_ids
|
@@ -1129,8 +1300,7 @@ module Orb
|
|
1129
1300
|
percentage_discount: Float,
|
1130
1301
|
start_date: Time,
|
1131
1302
|
discount_type: Symbol
|
1132
|
-
)
|
1133
|
-
.returns(T.attached_class)
|
1303
|
+
).returns(T.attached_class)
|
1134
1304
|
end
|
1135
1305
|
def self.new(
|
1136
1306
|
# The price ids that this discount interval applies to.
|
@@ -1145,24 +1315,28 @@ module Orb
|
|
1145
1315
|
# The start date of the discount interval.
|
1146
1316
|
start_date:,
|
1147
1317
|
discount_type: :percentage
|
1148
|
-
)
|
1318
|
+
)
|
1319
|
+
end
|
1320
|
+
|
1149
1321
|
sig do
|
1150
|
-
override
|
1151
|
-
|
1152
|
-
|
1153
|
-
|
1154
|
-
|
1155
|
-
|
1156
|
-
|
1157
|
-
|
1158
|
-
|
1159
|
-
|
1160
|
-
|
1322
|
+
override.returns(
|
1323
|
+
{
|
1324
|
+
applies_to_price_ids: T::Array[String],
|
1325
|
+
applies_to_price_interval_ids: T::Array[String],
|
1326
|
+
discount_type: Symbol,
|
1327
|
+
end_date: T.nilable(Time),
|
1328
|
+
percentage_discount: Float,
|
1329
|
+
start_date: Time
|
1330
|
+
}
|
1331
|
+
)
|
1332
|
+
end
|
1333
|
+
def to_hash
|
1161
1334
|
end
|
1162
|
-
def to_hash; end
|
1163
1335
|
end
|
1164
1336
|
|
1165
1337
|
class Usage < Orb::Internal::Type::BaseModel
|
1338
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1339
|
+
|
1166
1340
|
# The price ids that this discount interval applies to.
|
1167
1341
|
sig { returns(T::Array[String]) }
|
1168
1342
|
attr_accessor :applies_to_price_ids
|
@@ -1195,8 +1369,7 @@ module Orb
|
|
1195
1369
|
start_date: Time,
|
1196
1370
|
usage_discount: Float,
|
1197
1371
|
discount_type: Symbol
|
1198
|
-
)
|
1199
|
-
.returns(T.attached_class)
|
1372
|
+
).returns(T.attached_class)
|
1200
1373
|
end
|
1201
1374
|
def self.new(
|
1202
1375
|
# The price ids that this discount interval applies to.
|
@@ -1211,33 +1384,39 @@ module Orb
|
|
1211
1384
|
# discount is for
|
1212
1385
|
usage_discount:,
|
1213
1386
|
discount_type: :usage
|
1214
|
-
)
|
1387
|
+
)
|
1388
|
+
end
|
1389
|
+
|
1215
1390
|
sig do
|
1216
|
-
override
|
1217
|
-
|
1218
|
-
|
1219
|
-
|
1220
|
-
|
1221
|
-
|
1222
|
-
|
1223
|
-
|
1224
|
-
|
1225
|
-
|
1226
|
-
|
1391
|
+
override.returns(
|
1392
|
+
{
|
1393
|
+
applies_to_price_ids: T::Array[String],
|
1394
|
+
applies_to_price_interval_ids: T::Array[String],
|
1395
|
+
discount_type: Symbol,
|
1396
|
+
end_date: T.nilable(Time),
|
1397
|
+
start_date: Time,
|
1398
|
+
usage_discount: Float
|
1399
|
+
}
|
1400
|
+
)
|
1401
|
+
end
|
1402
|
+
def to_hash
|
1227
1403
|
end
|
1228
|
-
def to_hash; end
|
1229
1404
|
end
|
1230
1405
|
|
1231
1406
|
sig do
|
1232
|
-
override
|
1233
|
-
|
1234
|
-
|
1235
|
-
|
1407
|
+
override.returns(
|
1408
|
+
T::Array[
|
1409
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Variants
|
1410
|
+
]
|
1411
|
+
)
|
1412
|
+
end
|
1413
|
+
def self.variants
|
1236
1414
|
end
|
1237
|
-
def self.variants; end
|
1238
1415
|
end
|
1239
1416
|
|
1240
1417
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
1418
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1419
|
+
|
1241
1420
|
sig { returns(T.nilable(Time)) }
|
1242
1421
|
attr_accessor :end_date
|
1243
1422
|
|
@@ -1251,18 +1430,33 @@ module Orb
|
|
1251
1430
|
attr_accessor :start_date
|
1252
1431
|
|
1253
1432
|
sig do
|
1254
|
-
params(
|
1255
|
-
.
|
1433
|
+
params(
|
1434
|
+
end_date: T.nilable(Time),
|
1435
|
+
price_id: String,
|
1436
|
+
quantity: Float,
|
1437
|
+
start_date: Time
|
1438
|
+
).returns(T.attached_class)
|
1439
|
+
end
|
1440
|
+
def self.new(end_date:, price_id:, quantity:, start_date:)
|
1256
1441
|
end
|
1257
|
-
def self.new(end_date:, price_id:, quantity:, start_date:); end
|
1258
1442
|
|
1259
1443
|
sig do
|
1260
|
-
override.returns(
|
1444
|
+
override.returns(
|
1445
|
+
{
|
1446
|
+
end_date: T.nilable(Time),
|
1447
|
+
price_id: String,
|
1448
|
+
quantity: Float,
|
1449
|
+
start_date: Time
|
1450
|
+
}
|
1451
|
+
)
|
1452
|
+
end
|
1453
|
+
def to_hash
|
1261
1454
|
end
|
1262
|
-
def to_hash; end
|
1263
1455
|
end
|
1264
1456
|
|
1265
1457
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
1458
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1459
|
+
|
1266
1460
|
# The price ids that this maximum interval applies to.
|
1267
1461
|
sig { returns(T::Array[String]) }
|
1268
1462
|
attr_accessor :applies_to_price_ids
|
@@ -1291,8 +1485,7 @@ module Orb
|
|
1291
1485
|
end_date: T.nilable(Time),
|
1292
1486
|
maximum_amount: String,
|
1293
1487
|
start_date: Time
|
1294
|
-
)
|
1295
|
-
.returns(T.attached_class)
|
1488
|
+
).returns(T.attached_class)
|
1296
1489
|
end
|
1297
1490
|
def self.new(
|
1298
1491
|
# The price ids that this maximum interval applies to.
|
@@ -1306,23 +1499,27 @@ module Orb
|
|
1306
1499
|
maximum_amount:,
|
1307
1500
|
# The start date of the maximum interval.
|
1308
1501
|
start_date:
|
1309
|
-
)
|
1502
|
+
)
|
1503
|
+
end
|
1504
|
+
|
1310
1505
|
sig do
|
1311
|
-
override
|
1312
|
-
|
1313
|
-
|
1314
|
-
|
1315
|
-
|
1316
|
-
|
1317
|
-
|
1318
|
-
|
1319
|
-
|
1320
|
-
|
1506
|
+
override.returns(
|
1507
|
+
{
|
1508
|
+
applies_to_price_ids: T::Array[String],
|
1509
|
+
applies_to_price_interval_ids: T::Array[String],
|
1510
|
+
end_date: T.nilable(Time),
|
1511
|
+
maximum_amount: String,
|
1512
|
+
start_date: Time
|
1513
|
+
}
|
1514
|
+
)
|
1515
|
+
end
|
1516
|
+
def to_hash
|
1321
1517
|
end
|
1322
|
-
def to_hash; end
|
1323
1518
|
end
|
1324
1519
|
|
1325
1520
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
1521
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1522
|
+
|
1326
1523
|
# The price ids that this minimum interval applies to.
|
1327
1524
|
sig { returns(T::Array[String]) }
|
1328
1525
|
attr_accessor :applies_to_price_ids
|
@@ -1351,8 +1548,7 @@ module Orb
|
|
1351
1548
|
end_date: T.nilable(Time),
|
1352
1549
|
minimum_amount: String,
|
1353
1550
|
start_date: Time
|
1354
|
-
)
|
1355
|
-
.returns(T.attached_class)
|
1551
|
+
).returns(T.attached_class)
|
1356
1552
|
end
|
1357
1553
|
def self.new(
|
1358
1554
|
# The price ids that this minimum interval applies to.
|
@@ -1366,35 +1562,43 @@ module Orb
|
|
1366
1562
|
minimum_amount:,
|
1367
1563
|
# The start date of the minimum interval.
|
1368
1564
|
start_date:
|
1369
|
-
)
|
1565
|
+
)
|
1566
|
+
end
|
1567
|
+
|
1370
1568
|
sig do
|
1371
|
-
override
|
1372
|
-
|
1373
|
-
|
1374
|
-
|
1375
|
-
|
1376
|
-
|
1377
|
-
|
1378
|
-
|
1379
|
-
|
1380
|
-
|
1569
|
+
override.returns(
|
1570
|
+
{
|
1571
|
+
applies_to_price_ids: T::Array[String],
|
1572
|
+
applies_to_price_interval_ids: T::Array[String],
|
1573
|
+
end_date: T.nilable(Time),
|
1574
|
+
minimum_amount: String,
|
1575
|
+
start_date: Time
|
1576
|
+
}
|
1577
|
+
)
|
1578
|
+
end
|
1579
|
+
def to_hash
|
1381
1580
|
end
|
1382
|
-
def to_hash; end
|
1383
1581
|
end
|
1384
1582
|
|
1385
1583
|
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
1584
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1585
|
+
|
1386
1586
|
sig { returns(String) }
|
1387
1587
|
attr_accessor :id
|
1388
1588
|
|
1389
1589
|
# A pending subscription change if one exists on this subscription.
|
1390
1590
|
sig { params(id: String).returns(T.attached_class) }
|
1391
|
-
def self.new(id:)
|
1591
|
+
def self.new(id:)
|
1592
|
+
end
|
1392
1593
|
|
1393
|
-
sig { override.returns({id: String}) }
|
1394
|
-
def to_hash
|
1594
|
+
sig { override.returns({ id: String }) }
|
1595
|
+
def to_hash
|
1596
|
+
end
|
1395
1597
|
end
|
1396
1598
|
|
1397
1599
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
1600
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1601
|
+
|
1398
1602
|
sig { returns(String) }
|
1399
1603
|
attr_accessor :id
|
1400
1604
|
|
@@ -1428,7 +1632,9 @@ module Orb
|
|
1428
1632
|
sig do
|
1429
1633
|
returns(
|
1430
1634
|
T.nilable(
|
1431
|
-
T::Array[
|
1635
|
+
T::Array[
|
1636
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition
|
1637
|
+
]
|
1432
1638
|
)
|
1433
1639
|
)
|
1434
1640
|
end
|
@@ -1447,34 +1653,34 @@ module Orb
|
|
1447
1653
|
sig do
|
1448
1654
|
returns(
|
1449
1655
|
T.any(
|
1450
|
-
Orb::
|
1451
|
-
Orb::
|
1452
|
-
Orb::
|
1453
|
-
Orb::
|
1454
|
-
Orb::
|
1455
|
-
Orb::
|
1456
|
-
Orb::
|
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::
|
1656
|
+
Orb::Price::Unit,
|
1657
|
+
Orb::Price::Package,
|
1658
|
+
Orb::Price::Matrix,
|
1659
|
+
Orb::Price::Tiered,
|
1660
|
+
Orb::Price::TieredBps,
|
1661
|
+
Orb::Price::Bps,
|
1662
|
+
Orb::Price::BulkBps,
|
1663
|
+
Orb::Price::Bulk,
|
1664
|
+
Orb::Price::ThresholdTotalAmount,
|
1665
|
+
Orb::Price::TieredPackage,
|
1666
|
+
Orb::Price::GroupedTiered,
|
1667
|
+
Orb::Price::TieredWithMinimum,
|
1668
|
+
Orb::Price::TieredPackageWithMinimum,
|
1669
|
+
Orb::Price::PackageWithAllocation,
|
1670
|
+
Orb::Price::UnitWithPercent,
|
1671
|
+
Orb::Price::MatrixWithAllocation,
|
1672
|
+
Orb::Price::TieredWithProration,
|
1673
|
+
Orb::Price::UnitWithProration,
|
1674
|
+
Orb::Price::GroupedAllocation,
|
1675
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1676
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1677
|
+
Orb::Price::MatrixWithDisplayName,
|
1678
|
+
Orb::Price::BulkWithProration,
|
1679
|
+
Orb::Price::GroupedTieredPackage,
|
1680
|
+
Orb::Price::MaxGroupTieredPackage,
|
1681
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1682
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1683
|
+
Orb::Price::CumulativeGroupedBulk
|
1478
1684
|
)
|
1479
1685
|
)
|
1480
1686
|
end
|
@@ -1501,49 +1707,46 @@ module Orb
|
|
1501
1707
|
current_billing_period_start_date: T.nilable(Time),
|
1502
1708
|
end_date: T.nilable(Time),
|
1503
1709
|
filter: T.nilable(String),
|
1504
|
-
fixed_fee_quantity_transitions:
|
1505
|
-
T
|
1506
|
-
T
|
1507
|
-
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition
|
1508
|
-
|
1509
|
-
|
1510
|
-
|
1511
|
-
|
1512
|
-
|
1513
|
-
|
1514
|
-
|
1515
|
-
|
1516
|
-
|
1517
|
-
|
1518
|
-
|
1519
|
-
|
1520
|
-
|
1521
|
-
|
1522
|
-
|
1523
|
-
|
1524
|
-
|
1525
|
-
|
1526
|
-
|
1527
|
-
|
1528
|
-
|
1529
|
-
|
1530
|
-
|
1531
|
-
|
1532
|
-
|
1533
|
-
|
1534
|
-
|
1535
|
-
|
1536
|
-
|
1537
|
-
|
1538
|
-
|
1539
|
-
|
1540
|
-
|
1541
|
-
Orb::Models::Price::CumulativeGroupedBulk
|
1542
|
-
),
|
1710
|
+
fixed_fee_quantity_transitions:
|
1711
|
+
T.nilable(
|
1712
|
+
T::Array[
|
1713
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition::OrHash
|
1714
|
+
]
|
1715
|
+
),
|
1716
|
+
price:
|
1717
|
+
T.any(
|
1718
|
+
Orb::Price::Unit::OrHash,
|
1719
|
+
Orb::Price::Package::OrHash,
|
1720
|
+
Orb::Price::Matrix::OrHash,
|
1721
|
+
Orb::Price::Tiered::OrHash,
|
1722
|
+
Orb::Price::TieredBps::OrHash,
|
1723
|
+
Orb::Price::Bps::OrHash,
|
1724
|
+
Orb::Price::BulkBps::OrHash,
|
1725
|
+
Orb::Price::Bulk::OrHash,
|
1726
|
+
Orb::Price::ThresholdTotalAmount::OrHash,
|
1727
|
+
Orb::Price::TieredPackage::OrHash,
|
1728
|
+
Orb::Price::GroupedTiered::OrHash,
|
1729
|
+
Orb::Price::TieredWithMinimum::OrHash,
|
1730
|
+
Orb::Price::TieredPackageWithMinimum::OrHash,
|
1731
|
+
Orb::Price::PackageWithAllocation::OrHash,
|
1732
|
+
Orb::Price::UnitWithPercent::OrHash,
|
1733
|
+
Orb::Price::MatrixWithAllocation::OrHash,
|
1734
|
+
Orb::Price::TieredWithProration::OrHash,
|
1735
|
+
Orb::Price::UnitWithProration::OrHash,
|
1736
|
+
Orb::Price::GroupedAllocation::OrHash,
|
1737
|
+
Orb::Price::GroupedWithProratedMinimum::OrHash,
|
1738
|
+
Orb::Price::GroupedWithMeteredMinimum::OrHash,
|
1739
|
+
Orb::Price::MatrixWithDisplayName::OrHash,
|
1740
|
+
Orb::Price::BulkWithProration::OrHash,
|
1741
|
+
Orb::Price::GroupedTieredPackage::OrHash,
|
1742
|
+
Orb::Price::MaxGroupTieredPackage::OrHash,
|
1743
|
+
Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
|
1744
|
+
Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
|
1745
|
+
Orb::Price::CumulativeGroupedBulk::OrHash
|
1746
|
+
),
|
1543
1747
|
start_date: Time,
|
1544
1748
|
usage_customer_ids: T.nilable(T::Array[String])
|
1545
|
-
)
|
1546
|
-
.returns(T.attached_class)
|
1749
|
+
).returns(T.attached_class)
|
1547
1750
|
end
|
1548
1751
|
def self.new(
|
1549
1752
|
id:,
|
@@ -1582,58 +1785,66 @@ module Orb
|
|
1582
1785
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
1583
1786
|
# this price interval.
|
1584
1787
|
usage_customer_ids:
|
1585
|
-
)
|
1788
|
+
)
|
1789
|
+
end
|
1790
|
+
|
1586
1791
|
sig do
|
1587
|
-
override
|
1588
|
-
|
1589
|
-
|
1590
|
-
|
1591
|
-
|
1592
|
-
|
1593
|
-
|
1594
|
-
|
1595
|
-
|
1596
|
-
|
1597
|
-
T::Array[
|
1792
|
+
override.returns(
|
1793
|
+
{
|
1794
|
+
id: String,
|
1795
|
+
billing_cycle_day: Integer,
|
1796
|
+
current_billing_period_end_date: T.nilable(Time),
|
1797
|
+
current_billing_period_start_date: T.nilable(Time),
|
1798
|
+
end_date: T.nilable(Time),
|
1799
|
+
filter: T.nilable(String),
|
1800
|
+
fixed_fee_quantity_transitions:
|
1801
|
+
T.nilable(
|
1802
|
+
T::Array[
|
1803
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition
|
1804
|
+
]
|
1598
1805
|
),
|
1599
|
-
|
1600
|
-
|
1601
|
-
Orb::
|
1602
|
-
Orb::
|
1603
|
-
Orb::
|
1604
|
-
Orb::
|
1605
|
-
Orb::
|
1606
|
-
Orb::
|
1607
|
-
Orb::
|
1608
|
-
Orb::
|
1609
|
-
Orb::
|
1610
|
-
Orb::
|
1611
|
-
Orb::
|
1612
|
-
Orb::
|
1613
|
-
Orb::
|
1614
|
-
Orb::
|
1615
|
-
Orb::
|
1616
|
-
Orb::
|
1617
|
-
Orb::
|
1618
|
-
Orb::
|
1619
|
-
Orb::
|
1620
|
-
Orb::
|
1621
|
-
Orb::
|
1622
|
-
Orb::
|
1623
|
-
Orb::
|
1624
|
-
Orb::
|
1625
|
-
Orb::
|
1626
|
-
Orb::
|
1627
|
-
Orb::
|
1806
|
+
price:
|
1807
|
+
T.any(
|
1808
|
+
Orb::Price::Unit,
|
1809
|
+
Orb::Price::Package,
|
1810
|
+
Orb::Price::Matrix,
|
1811
|
+
Orb::Price::Tiered,
|
1812
|
+
Orb::Price::TieredBps,
|
1813
|
+
Orb::Price::Bps,
|
1814
|
+
Orb::Price::BulkBps,
|
1815
|
+
Orb::Price::Bulk,
|
1816
|
+
Orb::Price::ThresholdTotalAmount,
|
1817
|
+
Orb::Price::TieredPackage,
|
1818
|
+
Orb::Price::GroupedTiered,
|
1819
|
+
Orb::Price::TieredWithMinimum,
|
1820
|
+
Orb::Price::TieredPackageWithMinimum,
|
1821
|
+
Orb::Price::PackageWithAllocation,
|
1822
|
+
Orb::Price::UnitWithPercent,
|
1823
|
+
Orb::Price::MatrixWithAllocation,
|
1824
|
+
Orb::Price::TieredWithProration,
|
1825
|
+
Orb::Price::UnitWithProration,
|
1826
|
+
Orb::Price::GroupedAllocation,
|
1827
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1828
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1829
|
+
Orb::Price::MatrixWithDisplayName,
|
1830
|
+
Orb::Price::BulkWithProration,
|
1831
|
+
Orb::Price::GroupedTieredPackage,
|
1832
|
+
Orb::Price::MaxGroupTieredPackage,
|
1833
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1834
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1835
|
+
Orb::Price::CumulativeGroupedBulk
|
1628
1836
|
),
|
1629
|
-
|
1630
|
-
|
1631
|
-
|
1632
|
-
|
1837
|
+
start_date: Time,
|
1838
|
+
usage_customer_ids: T.nilable(T::Array[String])
|
1839
|
+
}
|
1840
|
+
)
|
1841
|
+
end
|
1842
|
+
def to_hash
|
1633
1843
|
end
|
1634
|
-
def to_hash; end
|
1635
1844
|
|
1636
1845
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1846
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1847
|
+
|
1637
1848
|
sig { returns(Time) }
|
1638
1849
|
attr_accessor :effective_date
|
1639
1850
|
|
@@ -1644,16 +1855,28 @@ module Orb
|
|
1644
1855
|
attr_accessor :quantity
|
1645
1856
|
|
1646
1857
|
sig do
|
1647
|
-
params(
|
1858
|
+
params(
|
1859
|
+
effective_date: Time,
|
1860
|
+
price_id: String,
|
1861
|
+
quantity: Integer
|
1862
|
+
).returns(T.attached_class)
|
1863
|
+
end
|
1864
|
+
def self.new(effective_date:, price_id:, quantity:)
|
1648
1865
|
end
|
1649
|
-
def self.new(effective_date:, price_id:, quantity:); end
|
1650
1866
|
|
1651
|
-
sig
|
1652
|
-
|
1867
|
+
sig do
|
1868
|
+
override.returns(
|
1869
|
+
{ effective_date: Time, price_id: String, quantity: Integer }
|
1870
|
+
)
|
1871
|
+
end
|
1872
|
+
def to_hash
|
1873
|
+
end
|
1653
1874
|
end
|
1654
1875
|
end
|
1655
1876
|
|
1656
1877
|
class RedeemedCoupon < Orb::Internal::Type::BaseModel
|
1878
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1879
|
+
|
1657
1880
|
sig { returns(String) }
|
1658
1881
|
attr_accessor :coupon_id
|
1659
1882
|
|
@@ -1664,61 +1887,95 @@ module Orb
|
|
1664
1887
|
attr_accessor :start_date
|
1665
1888
|
|
1666
1889
|
sig do
|
1667
|
-
params(
|
1890
|
+
params(
|
1891
|
+
coupon_id: String,
|
1892
|
+
end_date: T.nilable(Time),
|
1893
|
+
start_date: Time
|
1894
|
+
).returns(T.attached_class)
|
1895
|
+
end
|
1896
|
+
def self.new(coupon_id:, end_date:, start_date:)
|
1668
1897
|
end
|
1669
|
-
def self.new(coupon_id:, end_date:, start_date:); end
|
1670
1898
|
|
1671
|
-
sig
|
1672
|
-
|
1899
|
+
sig do
|
1900
|
+
override.returns(
|
1901
|
+
{ coupon_id: String, end_date: T.nilable(Time), start_date: Time }
|
1902
|
+
)
|
1903
|
+
end
|
1904
|
+
def to_hash
|
1905
|
+
end
|
1673
1906
|
end
|
1674
1907
|
|
1675
1908
|
module Status
|
1676
1909
|
extend Orb::Internal::Type::Enum
|
1677
1910
|
|
1678
1911
|
TaggedSymbol =
|
1679
|
-
T.type_alias
|
1912
|
+
T.type_alias do
|
1913
|
+
T.all(
|
1914
|
+
Symbol,
|
1915
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status
|
1916
|
+
)
|
1917
|
+
end
|
1680
1918
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1681
1919
|
|
1682
1920
|
ACTIVE =
|
1683
|
-
T.let(
|
1921
|
+
T.let(
|
1922
|
+
:active,
|
1923
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol
|
1924
|
+
)
|
1684
1925
|
ENDED =
|
1685
|
-
T.let(
|
1926
|
+
T.let(
|
1927
|
+
:ended,
|
1928
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol
|
1929
|
+
)
|
1686
1930
|
UPCOMING =
|
1687
|
-
T.let(
|
1931
|
+
T.let(
|
1932
|
+
:upcoming,
|
1933
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol
|
1934
|
+
)
|
1688
1935
|
|
1689
1936
|
sig do
|
1690
|
-
override
|
1691
|
-
|
1937
|
+
override.returns(
|
1938
|
+
T::Array[
|
1939
|
+
Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol
|
1940
|
+
]
|
1941
|
+
)
|
1942
|
+
end
|
1943
|
+
def self.values
|
1692
1944
|
end
|
1693
|
-
def self.values; end
|
1694
1945
|
end
|
1695
1946
|
|
1696
1947
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
1948
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1949
|
+
|
1697
1950
|
sig { returns(T.nilable(Time)) }
|
1698
1951
|
attr_accessor :end_date
|
1699
1952
|
|
1700
1953
|
sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
|
1701
|
-
def self.new(end_date:)
|
1954
|
+
def self.new(end_date:)
|
1955
|
+
end
|
1702
1956
|
|
1703
|
-
sig { override.returns({end_date: T.nilable(Time)}) }
|
1704
|
-
def to_hash
|
1957
|
+
sig { override.returns({ end_date: T.nilable(Time) }) }
|
1958
|
+
def to_hash
|
1959
|
+
end
|
1705
1960
|
end
|
1706
1961
|
|
1707
1962
|
class ChangedResources < Orb::Internal::Type::BaseModel
|
1963
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1964
|
+
|
1708
1965
|
# The credit notes that were created as part of this operation.
|
1709
|
-
sig { returns(T::Array[Orb::
|
1966
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1710
1967
|
attr_accessor :created_credit_notes
|
1711
1968
|
|
1712
1969
|
# The invoices that were created as part of this operation.
|
1713
|
-
sig { returns(T::Array[Orb::
|
1970
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1714
1971
|
attr_accessor :created_invoices
|
1715
1972
|
|
1716
1973
|
# The credit notes that were voided as part of this operation.
|
1717
|
-
sig { returns(T::Array[Orb::
|
1974
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1718
1975
|
attr_accessor :voided_credit_notes
|
1719
1976
|
|
1720
1977
|
# The invoices that were voided as part of this operation.
|
1721
|
-
sig { returns(T::Array[Orb::
|
1978
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1722
1979
|
attr_accessor :voided_invoices
|
1723
1980
|
|
1724
1981
|
# The resources that were changed as part of this operation. Only present when
|
@@ -1726,12 +1983,11 @@ module Orb
|
|
1726
1983
|
# `include_changed_resources` parameter was passed in the request.
|
1727
1984
|
sig do
|
1728
1985
|
params(
|
1729
|
-
created_credit_notes: T::Array[
|
1730
|
-
created_invoices: T::Array[
|
1731
|
-
voided_credit_notes: T::Array[
|
1732
|
-
voided_invoices: T::Array[
|
1733
|
-
)
|
1734
|
-
.returns(T.attached_class)
|
1986
|
+
created_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1987
|
+
created_invoices: T::Array[Orb::Invoice::OrHash],
|
1988
|
+
voided_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1989
|
+
voided_invoices: T::Array[Orb::Invoice::OrHash]
|
1990
|
+
).returns(T.attached_class)
|
1735
1991
|
end
|
1736
1992
|
def self.new(
|
1737
1993
|
# The credit notes that were created as part of this operation.
|
@@ -1742,19 +1998,21 @@ module Orb
|
|
1742
1998
|
voided_credit_notes:,
|
1743
1999
|
# The invoices that were voided as part of this operation.
|
1744
2000
|
voided_invoices:
|
1745
|
-
)
|
2001
|
+
)
|
2002
|
+
end
|
2003
|
+
|
1746
2004
|
sig do
|
1747
|
-
override
|
1748
|
-
|
1749
|
-
|
1750
|
-
|
1751
|
-
|
1752
|
-
|
1753
|
-
|
1754
|
-
|
1755
|
-
|
2005
|
+
override.returns(
|
2006
|
+
{
|
2007
|
+
created_credit_notes: T::Array[Orb::CreditNote],
|
2008
|
+
created_invoices: T::Array[Orb::Invoice],
|
2009
|
+
voided_credit_notes: T::Array[Orb::CreditNote],
|
2010
|
+
voided_invoices: T::Array[Orb::Invoice]
|
2011
|
+
}
|
2012
|
+
)
|
2013
|
+
end
|
2014
|
+
def to_hash
|
1756
2015
|
end
|
1757
|
-
def to_hash; end
|
1758
2016
|
end
|
1759
2017
|
end
|
1760
2018
|
end
|