orb-billing 0.3.1 → 0.4.0
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 +35 -0
- data/README.md +3 -3
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +62 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +4 -3
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +5 -4
- data/lib/orb/internal/util.rb +57 -1
- data/lib/orb/internal.rb +6 -0
- 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 +13 -12
- data/lib/orb/models/coupon_create_params.rb +12 -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 +50 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
- data/lib/orb/models/customer_update_params.rb +50 -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 +14 -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 +14 -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 +14 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -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 +11 -5
- data/lib/orb/models/evaluate_price_group.rb +5 -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 +179 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +8 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +28 -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 +90 -103
- data/lib/orb/models/plan_create_params.rb +759 -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 +1706 -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 +108 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +43 -57
- data/lib/orb/models/subscription_change_apply_response.rb +43 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
- data/lib/orb/models/subscription_create_params.rb +1953 -1815
- data/lib/orb/models/subscription_create_response.rb +43 -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 +1194 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -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 +43 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +8 -6
- data/lib/orb/models/subscription_update_trial_response.rb +43 -57
- data/lib/orb/models/subscription_usage.rb +55 -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/models.rb +24 -0
- data/lib/orb/request_options.rb +4 -0
- 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 +3 -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 +20 -6
- data/rbi/orb/internal/transport/base_client.rbi +159 -78
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +144 -69
- data/rbi/orb/internal/type/base_page.rbi +12 -8
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +68 -31
- data/rbi/orb/internal/type/enum.rbi +28 -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 +61 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +232 -90
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +114 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
- data/rbi/orb/models/alert_disable_params.rbi +18 -6
- data/rbi/orb/models/alert_enable_params.rbi +18 -6
- data/rbi/orb/models/alert_list_params.rbi +24 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
- data/rbi/orb/models/alert_update_params.rbi +29 -14
- data/rbi/orb/models/amount_discount.rbi +29 -19
- data/rbi/orb/models/billable_metric.rbi +34 -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 +11 -4
- data/rbi/orb/models/coupon_create_params.rbi +85 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
- data/rbi/orb/models/coupon_list_params.rbi +19 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
- data/rbi/orb/models/credit_note.rbi +329 -158
- data/rbi/orb/models/credit_note_create_params.rbi +64 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
- data/rbi/orb/models/credit_note_list_params.rbi +23 -17
- data/rbi/orb/models/customer.rbi +461 -329
- data/rbi/orb/models/customer_create_params.rbi +713 -325
- data/rbi/orb/models/customer_delete_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_params.rbi +11 -4
- data/rbi/orb/models/customer_list_params.rbi +21 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
- data/rbi/orb/models/customer_update_params.rbi +712 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
- data/rbi/orb/models/dimensional_price_group.rbi +21 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
- data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +29 -12
- data/rbi/orb/models/event_deprecate_params.rbi +13 -4
- data/rbi/orb/models/event_deprecate_response.rbi +11 -3
- data/rbi/orb/models/event_ingest_params.rbi +41 -31
- data/rbi/orb/models/event_ingest_response.rbi +78 -23
- data/rbi/orb/models/event_search_params.rbi +18 -14
- data/rbi/orb/models/event_search_response.rbi +42 -21
- data/rbi/orb/models/event_update_params.rbi +20 -16
- data/rbi/orb/models/event_update_response.rbi +11 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
- data/rbi/orb/models/events/event_volumes.rbi +38 -10
- data/rbi/orb/models/events/volume_list_params.rbi +21 -15
- data/rbi/orb/models/invoice.rbi +1411 -805
- data/rbi/orb/models/invoice_create_params.rbi +107 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
- data/rbi/orb/models/invoice_issue_params.rbi +17 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
- data/rbi/orb/models/invoice_list_params.rbi +68 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
- data/rbi/orb/models/invoice_pay_params.rbi +11 -4
- data/rbi/orb/models/invoice_update_params.rbi +16 -10
- data/rbi/orb/models/invoice_void_params.rbi +11 -4
- data/rbi/orb/models/item.rbi +90 -39
- data/rbi/orb/models/item_create_params.rbi +15 -5
- data/rbi/orb/models/item_fetch_params.rbi +11 -4
- data/rbi/orb/models/item_list_params.rbi +17 -6
- data/rbi/orb/models/item_update_params.rbi +86 -39
- data/rbi/orb/models/metric_create_params.rbi +20 -16
- data/rbi/orb/models/metric_fetch_params.rbi +11 -4
- data/rbi/orb/models/metric_list_params.rbi +21 -17
- data/rbi/orb/models/metric_update_params.rbi +16 -10
- data/rbi/orb/models/pagination_metadata.rbi +17 -4
- data/rbi/orb/models/percentage_discount.rbi +33 -19
- data/rbi/orb/models/plan.rbi +532 -365
- data/rbi/orb/models/plan_create_params.rbi +5295 -2870
- data/rbi/orb/models/plan_fetch_params.rbi +11 -4
- data/rbi/orb/models/plan_list_params.rbi +35 -27
- data/rbi/orb/models/plan_update_params.rbi +17 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
- data/rbi/orb/models/price.rbi +11332 -5033
- data/rbi/orb/models/price_create_params.rbi +583 -245
- data/rbi/orb/models/price_evaluate_params.rbi +21 -17
- data/rbi/orb/models/price_evaluate_response.rbi +14 -6
- data/rbi/orb/models/price_fetch_params.rbi +11 -4
- data/rbi/orb/models/price_list_params.rbi +17 -6
- data/rbi/orb/models/price_update_params.rbi +16 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
- data/rbi/orb/models/subscription.rbi +668 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
- data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
- data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
- data/rbi/orb/models/subscription_create_response.rbi +817 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
- data/rbi/orb/models/subscription_list_params.rbi +42 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
- data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
- data/rbi/orb/models/subscription_update_params.rbi +22 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
- data/rbi/orb/models/subscription_usage.rbi +325 -121
- data/rbi/orb/models/subscriptions.rbi +19 -11
- data/rbi/orb/models/top_level_ping_params.rbi +11 -4
- data/rbi/orb/models/top_level_ping_response.rbi +10 -3
- data/rbi/orb/models/trial_discount.rbi +30 -20
- data/rbi/orb/models/usage_discount.rbi +29 -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/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +11 -5
- data/sig/orb/internal/type/base_page.rbs +1 -1
- data/sig/orb/internal/type/converter.rbs +2 -0
- data/sig/orb/internal/type/enum.rbs +1 -0
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/type/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.rbs +2 -0
- 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,14 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(
|
9
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse,
|
10
|
+
Orb::Internal::AnyHash
|
11
|
+
)
|
12
|
+
end
|
13
|
+
|
6
14
|
sig { returns(String) }
|
7
15
|
attr_accessor :id
|
8
16
|
|
@@ -13,7 +21,13 @@ module Orb
|
|
13
21
|
|
14
22
|
# The adjustment intervals for this subscription sorted by the start_date of the
|
15
23
|
# adjustment interval.
|
16
|
-
sig
|
24
|
+
sig do
|
25
|
+
returns(
|
26
|
+
T::Array[
|
27
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval
|
28
|
+
]
|
29
|
+
)
|
30
|
+
end
|
17
31
|
attr_accessor :adjustment_intervals
|
18
32
|
|
19
33
|
# Determines whether issued invoices for this subscription will automatically be
|
@@ -22,17 +36,18 @@ module Orb
|
|
22
36
|
sig { returns(T.nilable(T::Boolean)) }
|
23
37
|
attr_accessor :auto_collection
|
24
38
|
|
25
|
-
sig
|
39
|
+
sig do
|
40
|
+
returns(
|
41
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration
|
42
|
+
)
|
43
|
+
end
|
26
44
|
attr_reader :billing_cycle_anchor_configuration
|
27
45
|
|
28
46
|
sig do
|
29
47
|
params(
|
30
|
-
billing_cycle_anchor_configuration:
|
31
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration
|
32
|
-
|
33
|
-
)
|
34
|
-
)
|
35
|
-
.void
|
48
|
+
billing_cycle_anchor_configuration:
|
49
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration::OrHash
|
50
|
+
).void
|
36
51
|
end
|
37
52
|
attr_writer :billing_cycle_anchor_configuration
|
38
53
|
|
@@ -76,10 +91,10 @@ module Orb
|
|
76
91
|
# [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
|
77
92
|
# your account's timezone. See [Timezone localization](/essentials/timezones) for
|
78
93
|
# information on what this timezone parameter influences within Orb.
|
79
|
-
sig { returns(Orb::
|
94
|
+
sig { returns(Orb::Customer) }
|
80
95
|
attr_reader :customer
|
81
96
|
|
82
|
-
sig { params(customer:
|
97
|
+
sig { params(customer: Orb::Customer::OrHash).void }
|
83
98
|
attr_writer :customer
|
84
99
|
|
85
100
|
# Determines the default memo on this subscriptions' invoices. Note that if this
|
@@ -105,14 +120,26 @@ module Orb
|
|
105
120
|
sig { returns(T.nilable(Time)) }
|
106
121
|
attr_accessor :end_date
|
107
122
|
|
108
|
-
sig
|
123
|
+
sig do
|
124
|
+
returns(
|
125
|
+
T::Array[
|
126
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule
|
127
|
+
]
|
128
|
+
)
|
129
|
+
end
|
109
130
|
attr_accessor :fixed_fee_quantity_schedule
|
110
131
|
|
111
132
|
sig { returns(T.nilable(String)) }
|
112
133
|
attr_accessor :invoicing_threshold
|
113
134
|
|
114
135
|
# The maximum intervals for this subscription sorted by the start_date.
|
115
|
-
sig
|
136
|
+
sig do
|
137
|
+
returns(
|
138
|
+
T::Array[
|
139
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval
|
140
|
+
]
|
141
|
+
)
|
142
|
+
end
|
116
143
|
attr_accessor :maximum_intervals
|
117
144
|
|
118
145
|
# User specified key-value pairs for the resource. If not present, this defaults
|
@@ -123,7 +150,13 @@ module Orb
|
|
123
150
|
attr_accessor :metadata
|
124
151
|
|
125
152
|
# The minimum intervals for this subscription sorted by the start_date.
|
126
|
-
sig
|
153
|
+
sig do
|
154
|
+
returns(
|
155
|
+
T::Array[
|
156
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval
|
157
|
+
]
|
158
|
+
)
|
159
|
+
end
|
127
160
|
attr_accessor :minimum_intervals
|
128
161
|
|
129
162
|
# Determines the difference between the invoice issue date for subscription
|
@@ -134,19 +167,22 @@ module Orb
|
|
134
167
|
attr_accessor :net_terms
|
135
168
|
|
136
169
|
# A pending subscription change if one exists on this subscription.
|
137
|
-
sig
|
170
|
+
sig do
|
171
|
+
returns(
|
172
|
+
T.nilable(
|
173
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
|
174
|
+
)
|
175
|
+
)
|
176
|
+
end
|
138
177
|
attr_reader :pending_subscription_change
|
139
178
|
|
140
179
|
sig do
|
141
180
|
params(
|
142
|
-
pending_subscription_change:
|
143
|
-
T.
|
144
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
|
145
|
-
Orb::Internal::AnyHash
|
181
|
+
pending_subscription_change:
|
182
|
+
T.nilable(
|
183
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange::OrHash
|
146
184
|
)
|
147
|
-
|
148
|
-
)
|
149
|
-
.void
|
185
|
+
).void
|
150
186
|
end
|
151
187
|
attr_writer :pending_subscription_change
|
152
188
|
|
@@ -154,26 +190,38 @@ module Orb
|
|
154
190
|
# subscribed to by a customer. Plans define the billing behavior of the
|
155
191
|
# subscription. You can see more about how to configure prices in the
|
156
192
|
# [Price resource](/reference/price).
|
157
|
-
sig { returns(Orb::
|
193
|
+
sig { returns(Orb::Plan) }
|
158
194
|
attr_reader :plan
|
159
195
|
|
160
|
-
sig { params(plan:
|
196
|
+
sig { params(plan: Orb::Plan::OrHash).void }
|
161
197
|
attr_writer :plan
|
162
198
|
|
163
199
|
# The price intervals for this subscription.
|
164
|
-
sig
|
200
|
+
sig do
|
201
|
+
returns(
|
202
|
+
T::Array[
|
203
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval
|
204
|
+
]
|
205
|
+
)
|
206
|
+
end
|
165
207
|
attr_accessor :price_intervals
|
166
208
|
|
167
|
-
sig
|
209
|
+
sig do
|
210
|
+
returns(
|
211
|
+
T.nilable(
|
212
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon
|
213
|
+
)
|
214
|
+
)
|
215
|
+
end
|
168
216
|
attr_reader :redeemed_coupon
|
169
217
|
|
170
218
|
sig do
|
171
219
|
params(
|
172
|
-
redeemed_coupon:
|
173
|
-
T.
|
174
|
-
|
175
|
-
|
176
|
-
|
220
|
+
redeemed_coupon:
|
221
|
+
T.nilable(
|
222
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon::OrHash
|
223
|
+
)
|
224
|
+
).void
|
177
225
|
end
|
178
226
|
attr_writer :redeemed_coupon
|
179
227
|
|
@@ -181,33 +229,45 @@ module Orb
|
|
181
229
|
sig { returns(Time) }
|
182
230
|
attr_accessor :start_date
|
183
231
|
|
184
|
-
sig
|
232
|
+
sig do
|
233
|
+
returns(
|
234
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
235
|
+
)
|
236
|
+
end
|
185
237
|
attr_accessor :status
|
186
238
|
|
187
|
-
sig
|
239
|
+
sig do
|
240
|
+
returns(Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo)
|
241
|
+
end
|
188
242
|
attr_reader :trial_info
|
189
243
|
|
190
244
|
sig do
|
191
245
|
params(
|
192
|
-
trial_info:
|
193
|
-
|
194
|
-
|
246
|
+
trial_info:
|
247
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo::OrHash
|
248
|
+
).void
|
195
249
|
end
|
196
250
|
attr_writer :trial_info
|
197
251
|
|
198
252
|
# The resources that were changed as part of this operation. Only present when
|
199
253
|
# fetched through the subscription changes API or if the
|
200
254
|
# `include_changed_resources` parameter was passed in the request.
|
201
|
-
sig
|
255
|
+
sig do
|
256
|
+
returns(
|
257
|
+
T.nilable(
|
258
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources
|
259
|
+
)
|
260
|
+
)
|
261
|
+
end
|
202
262
|
attr_reader :changed_resources
|
203
263
|
|
204
264
|
sig do
|
205
265
|
params(
|
206
|
-
changed_resources:
|
207
|
-
T.
|
208
|
-
|
209
|
-
|
210
|
-
|
266
|
+
changed_resources:
|
267
|
+
T.nilable(
|
268
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources::OrHash
|
269
|
+
)
|
270
|
+
).void
|
211
271
|
end
|
212
272
|
attr_writer :changed_resources
|
213
273
|
|
@@ -215,57 +275,66 @@ module Orb
|
|
215
275
|
params(
|
216
276
|
id: String,
|
217
277
|
active_plan_phase_order: T.nilable(Integer),
|
218
|
-
adjustment_intervals:
|
278
|
+
adjustment_intervals:
|
279
|
+
T::Array[
|
280
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::OrHash
|
281
|
+
],
|
219
282
|
auto_collection: T.nilable(T::Boolean),
|
220
|
-
billing_cycle_anchor_configuration:
|
221
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration,
|
222
|
-
Orb::Internal::AnyHash
|
223
|
-
),
|
283
|
+
billing_cycle_anchor_configuration:
|
284
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration::OrHash,
|
224
285
|
billing_cycle_day: Integer,
|
225
286
|
created_at: Time,
|
226
287
|
current_billing_period_end_date: T.nilable(Time),
|
227
288
|
current_billing_period_start_date: T.nilable(Time),
|
228
|
-
customer:
|
289
|
+
customer: Orb::Customer::OrHash,
|
229
290
|
default_invoice_memo: T.nilable(String),
|
230
|
-
discount_intervals:
|
231
|
-
T
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
291
|
+
discount_intervals:
|
292
|
+
T::Array[
|
293
|
+
T.any(
|
294
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::OrHash,
|
295
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::OrHash,
|
296
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::OrHash
|
297
|
+
)
|
298
|
+
],
|
238
299
|
end_date: T.nilable(Time),
|
239
|
-
fixed_fee_quantity_schedule:
|
240
|
-
T
|
241
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule
|
242
|
-
|
243
|
-
)
|
244
|
-
],
|
300
|
+
fixed_fee_quantity_schedule:
|
301
|
+
T::Array[
|
302
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule::OrHash
|
303
|
+
],
|
245
304
|
invoicing_threshold: T.nilable(String),
|
246
|
-
maximum_intervals:
|
305
|
+
maximum_intervals:
|
306
|
+
T::Array[
|
307
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::OrHash
|
308
|
+
],
|
247
309
|
metadata: T::Hash[Symbol, String],
|
248
|
-
minimum_intervals:
|
310
|
+
minimum_intervals:
|
311
|
+
T::Array[
|
312
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::OrHash
|
313
|
+
],
|
249
314
|
net_terms: Integer,
|
250
|
-
pending_subscription_change:
|
251
|
-
T.
|
252
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
315
|
+
pending_subscription_change:
|
316
|
+
T.nilable(
|
317
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange::OrHash
|
318
|
+
),
|
319
|
+
plan: Orb::Plan::OrHash,
|
320
|
+
price_intervals:
|
321
|
+
T::Array[
|
322
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::OrHash
|
323
|
+
],
|
324
|
+
redeemed_coupon:
|
325
|
+
T.nilable(
|
326
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon::OrHash
|
327
|
+
),
|
261
328
|
start_date: Time,
|
262
|
-
status:
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
329
|
+
status:
|
330
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::OrSymbol,
|
331
|
+
trial_info:
|
332
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo::OrHash,
|
333
|
+
changed_resources:
|
334
|
+
T.nilable(
|
335
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources::OrHash
|
336
|
+
)
|
337
|
+
).returns(T.attached_class)
|
269
338
|
end
|
270
339
|
def self.new(
|
271
340
|
id:,
|
@@ -354,50 +423,88 @@ module Orb
|
|
354
423
|
# fetched through the subscription changes API or if the
|
355
424
|
# `include_changed_resources` parameter was passed in the request.
|
356
425
|
changed_resources: nil
|
357
|
-
)
|
426
|
+
)
|
427
|
+
end
|
428
|
+
|
358
429
|
sig do
|
359
|
-
override
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
430
|
+
override.returns(
|
431
|
+
{
|
432
|
+
id: String,
|
433
|
+
active_plan_phase_order: T.nilable(Integer),
|
434
|
+
adjustment_intervals:
|
435
|
+
T::Array[
|
436
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval
|
437
|
+
],
|
438
|
+
auto_collection: T.nilable(T::Boolean),
|
439
|
+
billing_cycle_anchor_configuration:
|
440
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration,
|
441
|
+
billing_cycle_day: Integer,
|
442
|
+
created_at: Time,
|
443
|
+
current_billing_period_end_date: T.nilable(Time),
|
444
|
+
current_billing_period_start_date: T.nilable(Time),
|
445
|
+
customer: Orb::Customer,
|
446
|
+
default_invoice_memo: T.nilable(String),
|
447
|
+
discount_intervals:
|
448
|
+
T::Array[
|
374
449
|
T.any(
|
375
450
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount,
|
376
451
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage,
|
377
452
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage
|
378
453
|
)
|
379
454
|
],
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
455
|
+
end_date: T.nilable(Time),
|
456
|
+
fixed_fee_quantity_schedule:
|
457
|
+
T::Array[
|
458
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule
|
459
|
+
],
|
460
|
+
invoicing_threshold: T.nilable(String),
|
461
|
+
maximum_intervals:
|
462
|
+
T::Array[
|
463
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval
|
464
|
+
],
|
465
|
+
metadata: T::Hash[Symbol, String],
|
466
|
+
minimum_intervals:
|
467
|
+
T::Array[
|
468
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval
|
469
|
+
],
|
470
|
+
net_terms: Integer,
|
471
|
+
pending_subscription_change:
|
472
|
+
T.nilable(
|
473
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
|
474
|
+
),
|
475
|
+
plan: Orb::Plan,
|
476
|
+
price_intervals:
|
477
|
+
T::Array[
|
478
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval
|
479
|
+
],
|
480
|
+
redeemed_coupon:
|
481
|
+
T.nilable(
|
482
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon
|
483
|
+
),
|
484
|
+
start_date: Time,
|
485
|
+
status:
|
486
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol,
|
487
|
+
trial_info:
|
488
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo,
|
489
|
+
changed_resources:
|
490
|
+
T.nilable(
|
491
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources
|
492
|
+
)
|
493
|
+
}
|
494
|
+
)
|
495
|
+
end
|
496
|
+
def to_hash
|
397
497
|
end
|
398
|
-
def to_hash; end
|
399
498
|
|
400
499
|
class AdjustmentInterval < Orb::Internal::Type::BaseModel
|
500
|
+
OrHash =
|
501
|
+
T.type_alias do
|
502
|
+
T.any(
|
503
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval,
|
504
|
+
Orb::Internal::AnyHash
|
505
|
+
)
|
506
|
+
end
|
507
|
+
|
401
508
|
sig { returns(String) }
|
402
509
|
attr_accessor :id
|
403
510
|
|
@@ -429,19 +536,18 @@ module Orb
|
|
429
536
|
sig do
|
430
537
|
params(
|
431
538
|
id: String,
|
432
|
-
adjustment:
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
539
|
+
adjustment:
|
540
|
+
T.any(
|
541
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::OrHash,
|
542
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::OrHash,
|
543
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::OrHash,
|
544
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::OrHash,
|
545
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::OrHash
|
546
|
+
),
|
440
547
|
applies_to_price_interval_ids: T::Array[String],
|
441
548
|
end_date: T.nilable(Time),
|
442
549
|
start_date: Time
|
443
|
-
)
|
444
|
-
.returns(T.attached_class)
|
550
|
+
).returns(T.attached_class)
|
445
551
|
end
|
446
552
|
def self.new(
|
447
553
|
id:,
|
@@ -452,31 +558,53 @@ module Orb
|
|
452
558
|
end_date:,
|
453
559
|
# The start date of the adjustment interval.
|
454
560
|
start_date:
|
455
|
-
)
|
561
|
+
)
|
562
|
+
end
|
563
|
+
|
456
564
|
sig do
|
457
|
-
override
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
565
|
+
override.returns(
|
566
|
+
{
|
567
|
+
id: String,
|
568
|
+
adjustment:
|
569
|
+
T.any(
|
462
570
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
463
571
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
464
572
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
465
573
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum,
|
466
574
|
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum
|
467
575
|
),
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
576
|
+
applies_to_price_interval_ids: T::Array[String],
|
577
|
+
end_date: T.nilable(Time),
|
578
|
+
start_date: Time
|
579
|
+
}
|
580
|
+
)
|
581
|
+
end
|
582
|
+
def to_hash
|
473
583
|
end
|
474
|
-
def to_hash; end
|
475
584
|
|
476
585
|
module Adjustment
|
477
586
|
extend Orb::Internal::Type::Union
|
478
587
|
|
588
|
+
Variants =
|
589
|
+
T.type_alias do
|
590
|
+
T.any(
|
591
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
592
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
593
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
594
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum,
|
595
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum
|
596
|
+
)
|
597
|
+
end
|
598
|
+
|
479
599
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
600
|
+
OrHash =
|
601
|
+
T.type_alias do
|
602
|
+
T.any(
|
603
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount,
|
604
|
+
Orb::Internal::AnyHash
|
605
|
+
)
|
606
|
+
end
|
607
|
+
|
480
608
|
sig { returns(String) }
|
481
609
|
attr_accessor :id
|
482
610
|
|
@@ -514,8 +642,7 @@ module Orb
|
|
514
642
|
reason: T.nilable(String),
|
515
643
|
usage_discount: Float,
|
516
644
|
adjustment_type: Symbol
|
517
|
-
)
|
518
|
-
.returns(T.attached_class)
|
645
|
+
).returns(T.attached_class)
|
519
646
|
end
|
520
647
|
def self.new(
|
521
648
|
id:,
|
@@ -532,25 +659,35 @@ module Orb
|
|
532
659
|
# to in a given billing period.
|
533
660
|
usage_discount:,
|
534
661
|
adjustment_type: :usage_discount
|
535
|
-
)
|
662
|
+
)
|
663
|
+
end
|
664
|
+
|
536
665
|
sig do
|
537
|
-
override
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
666
|
+
override.returns(
|
667
|
+
{
|
668
|
+
id: String,
|
669
|
+
adjustment_type: Symbol,
|
670
|
+
applies_to_price_ids: T::Array[String],
|
671
|
+
is_invoice_level: T::Boolean,
|
672
|
+
plan_phase_order: T.nilable(Integer),
|
673
|
+
reason: T.nilable(String),
|
674
|
+
usage_discount: Float
|
675
|
+
}
|
676
|
+
)
|
677
|
+
end
|
678
|
+
def to_hash
|
549
679
|
end
|
550
|
-
def to_hash; end
|
551
680
|
end
|
552
681
|
|
553
682
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
683
|
+
OrHash =
|
684
|
+
T.type_alias do
|
685
|
+
T.any(
|
686
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount,
|
687
|
+
Orb::Internal::AnyHash
|
688
|
+
)
|
689
|
+
end
|
690
|
+
|
554
691
|
sig { returns(String) }
|
555
692
|
attr_accessor :id
|
556
693
|
|
@@ -588,8 +725,7 @@ module Orb
|
|
588
725
|
plan_phase_order: T.nilable(Integer),
|
589
726
|
reason: T.nilable(String),
|
590
727
|
adjustment_type: Symbol
|
591
|
-
)
|
592
|
-
.returns(T.attached_class)
|
728
|
+
).returns(T.attached_class)
|
593
729
|
end
|
594
730
|
def self.new(
|
595
731
|
id:,
|
@@ -606,25 +742,35 @@ module Orb
|
|
606
742
|
# The reason for the adjustment.
|
607
743
|
reason:,
|
608
744
|
adjustment_type: :amount_discount
|
609
|
-
)
|
745
|
+
)
|
746
|
+
end
|
747
|
+
|
610
748
|
sig do
|
611
|
-
override
|
612
|
-
|
613
|
-
|
614
|
-
|
615
|
-
|
616
|
-
|
617
|
-
|
618
|
-
|
619
|
-
|
620
|
-
|
621
|
-
|
622
|
-
|
749
|
+
override.returns(
|
750
|
+
{
|
751
|
+
id: String,
|
752
|
+
adjustment_type: Symbol,
|
753
|
+
amount_discount: String,
|
754
|
+
applies_to_price_ids: T::Array[String],
|
755
|
+
is_invoice_level: T::Boolean,
|
756
|
+
plan_phase_order: T.nilable(Integer),
|
757
|
+
reason: T.nilable(String)
|
758
|
+
}
|
759
|
+
)
|
760
|
+
end
|
761
|
+
def to_hash
|
623
762
|
end
|
624
|
-
def to_hash; end
|
625
763
|
end
|
626
764
|
|
627
765
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
766
|
+
OrHash =
|
767
|
+
T.type_alias do
|
768
|
+
T.any(
|
769
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
|
770
|
+
Orb::Internal::AnyHash
|
771
|
+
)
|
772
|
+
end
|
773
|
+
|
628
774
|
sig { returns(String) }
|
629
775
|
attr_accessor :id
|
630
776
|
|
@@ -662,8 +808,7 @@ module Orb
|
|
662
808
|
plan_phase_order: T.nilable(Integer),
|
663
809
|
reason: T.nilable(String),
|
664
810
|
adjustment_type: Symbol
|
665
|
-
)
|
666
|
-
.returns(T.attached_class)
|
811
|
+
).returns(T.attached_class)
|
667
812
|
end
|
668
813
|
def self.new(
|
669
814
|
id:,
|
@@ -680,25 +825,35 @@ module Orb
|
|
680
825
|
# The reason for the adjustment.
|
681
826
|
reason:,
|
682
827
|
adjustment_type: :percentage_discount
|
683
|
-
)
|
828
|
+
)
|
829
|
+
end
|
830
|
+
|
684
831
|
sig do
|
685
|
-
override
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
832
|
+
override.returns(
|
833
|
+
{
|
834
|
+
id: String,
|
835
|
+
adjustment_type: Symbol,
|
836
|
+
applies_to_price_ids: T::Array[String],
|
837
|
+
is_invoice_level: T::Boolean,
|
838
|
+
percentage_discount: Float,
|
839
|
+
plan_phase_order: T.nilable(Integer),
|
840
|
+
reason: T.nilable(String)
|
841
|
+
}
|
842
|
+
)
|
843
|
+
end
|
844
|
+
def to_hash
|
697
845
|
end
|
698
|
-
def to_hash; end
|
699
846
|
end
|
700
847
|
|
701
848
|
class Minimum < Orb::Internal::Type::BaseModel
|
849
|
+
OrHash =
|
850
|
+
T.type_alias do
|
851
|
+
T.any(
|
852
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum,
|
853
|
+
Orb::Internal::AnyHash
|
854
|
+
)
|
855
|
+
end
|
856
|
+
|
702
857
|
sig { returns(String) }
|
703
858
|
attr_accessor :id
|
704
859
|
|
@@ -741,8 +896,7 @@ module Orb
|
|
741
896
|
plan_phase_order: T.nilable(Integer),
|
742
897
|
reason: T.nilable(String),
|
743
898
|
adjustment_type: Symbol
|
744
|
-
)
|
745
|
-
.returns(T.attached_class)
|
899
|
+
).returns(T.attached_class)
|
746
900
|
end
|
747
901
|
def self.new(
|
748
902
|
id:,
|
@@ -761,26 +915,36 @@ module Orb
|
|
761
915
|
# The reason for the adjustment.
|
762
916
|
reason:,
|
763
917
|
adjustment_type: :minimum
|
764
|
-
)
|
918
|
+
)
|
919
|
+
end
|
920
|
+
|
765
921
|
sig do
|
766
|
-
override
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
922
|
+
override.returns(
|
923
|
+
{
|
924
|
+
id: String,
|
925
|
+
adjustment_type: Symbol,
|
926
|
+
applies_to_price_ids: T::Array[String],
|
927
|
+
is_invoice_level: T::Boolean,
|
928
|
+
item_id: String,
|
929
|
+
minimum_amount: String,
|
930
|
+
plan_phase_order: T.nilable(Integer),
|
931
|
+
reason: T.nilable(String)
|
932
|
+
}
|
933
|
+
)
|
934
|
+
end
|
935
|
+
def to_hash
|
779
936
|
end
|
780
|
-
def to_hash; end
|
781
937
|
end
|
782
938
|
|
783
939
|
class Maximum < Orb::Internal::Type::BaseModel
|
940
|
+
OrHash =
|
941
|
+
T.type_alias do
|
942
|
+
T.any(
|
943
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum,
|
944
|
+
Orb::Internal::AnyHash
|
945
|
+
)
|
946
|
+
end
|
947
|
+
|
784
948
|
sig { returns(String) }
|
785
949
|
attr_accessor :id
|
786
950
|
|
@@ -818,8 +982,7 @@ module Orb
|
|
818
982
|
plan_phase_order: T.nilable(Integer),
|
819
983
|
reason: T.nilable(String),
|
820
984
|
adjustment_type: Symbol
|
821
|
-
)
|
822
|
-
.returns(T.attached_class)
|
985
|
+
).returns(T.attached_class)
|
823
986
|
end
|
824
987
|
def self.new(
|
825
988
|
id:,
|
@@ -836,35 +999,47 @@ module Orb
|
|
836
999
|
# The reason for the adjustment.
|
837
1000
|
reason:,
|
838
1001
|
adjustment_type: :maximum
|
839
|
-
)
|
1002
|
+
)
|
1003
|
+
end
|
1004
|
+
|
840
1005
|
sig do
|
841
|
-
override
|
842
|
-
|
843
|
-
|
844
|
-
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
1006
|
+
override.returns(
|
1007
|
+
{
|
1008
|
+
id: String,
|
1009
|
+
adjustment_type: Symbol,
|
1010
|
+
applies_to_price_ids: T::Array[String],
|
1011
|
+
is_invoice_level: T::Boolean,
|
1012
|
+
maximum_amount: String,
|
1013
|
+
plan_phase_order: T.nilable(Integer),
|
1014
|
+
reason: T.nilable(String)
|
1015
|
+
}
|
1016
|
+
)
|
1017
|
+
end
|
1018
|
+
def to_hash
|
853
1019
|
end
|
854
|
-
def to_hash; end
|
855
1020
|
end
|
856
1021
|
|
857
1022
|
sig do
|
858
|
-
override
|
859
|
-
|
860
|
-
|
861
|
-
|
1023
|
+
override.returns(
|
1024
|
+
T::Array[
|
1025
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Variants
|
1026
|
+
]
|
1027
|
+
)
|
1028
|
+
end
|
1029
|
+
def self.variants
|
862
1030
|
end
|
863
|
-
def self.variants; end
|
864
1031
|
end
|
865
1032
|
end
|
866
1033
|
|
867
1034
|
class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
|
1035
|
+
OrHash =
|
1036
|
+
T.type_alias do
|
1037
|
+
T.any(
|
1038
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration,
|
1039
|
+
Orb::Internal::AnyHash
|
1040
|
+
)
|
1041
|
+
end
|
1042
|
+
|
868
1043
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
869
1044
|
# number of days in a month is greater than this value, the last day of the month
|
870
1045
|
# is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
|
@@ -884,7 +1059,11 @@ module Orb
|
|
884
1059
|
attr_accessor :year
|
885
1060
|
|
886
1061
|
sig do
|
887
|
-
params(
|
1062
|
+
params(
|
1063
|
+
day: Integer,
|
1064
|
+
month: T.nilable(Integer),
|
1065
|
+
year: T.nilable(Integer)
|
1066
|
+
).returns(T.attached_class)
|
888
1067
|
end
|
889
1068
|
def self.new(
|
890
1069
|
# The day of the month on which the billing cycle is anchored. If the maximum
|
@@ -899,15 +1078,43 @@ module Orb
|
|
899
1078
|
# The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
|
900
1079
|
# anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
|
901
1080
|
year: nil
|
902
|
-
)
|
903
|
-
|
904
|
-
|
1081
|
+
)
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
sig do
|
1085
|
+
override.returns(
|
1086
|
+
{
|
1087
|
+
day: Integer,
|
1088
|
+
month: T.nilable(Integer),
|
1089
|
+
year: T.nilable(Integer)
|
1090
|
+
}
|
1091
|
+
)
|
1092
|
+
end
|
1093
|
+
def to_hash
|
1094
|
+
end
|
905
1095
|
end
|
906
1096
|
|
907
1097
|
module DiscountInterval
|
908
1098
|
extend Orb::Internal::Type::Union
|
909
1099
|
|
1100
|
+
Variants =
|
1101
|
+
T.type_alias do
|
1102
|
+
T.any(
|
1103
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount,
|
1104
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage,
|
1105
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage
|
1106
|
+
)
|
1107
|
+
end
|
1108
|
+
|
910
1109
|
class Amount < Orb::Internal::Type::BaseModel
|
1110
|
+
OrHash =
|
1111
|
+
T.type_alias do
|
1112
|
+
T.any(
|
1113
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount,
|
1114
|
+
Orb::Internal::AnyHash
|
1115
|
+
)
|
1116
|
+
end
|
1117
|
+
|
911
1118
|
# Only available if discount_type is `amount`.
|
912
1119
|
sig { returns(String) }
|
913
1120
|
attr_accessor :amount_discount
|
@@ -939,8 +1146,7 @@ module Orb
|
|
939
1146
|
end_date: T.nilable(Time),
|
940
1147
|
start_date: Time,
|
941
1148
|
discount_type: Symbol
|
942
|
-
)
|
943
|
-
.returns(T.attached_class)
|
1149
|
+
).returns(T.attached_class)
|
944
1150
|
end
|
945
1151
|
def self.new(
|
946
1152
|
# Only available if discount_type is `amount`.
|
@@ -954,24 +1160,34 @@ module Orb
|
|
954
1160
|
# The start date of the discount interval.
|
955
1161
|
start_date:,
|
956
1162
|
discount_type: :amount
|
957
|
-
)
|
1163
|
+
)
|
1164
|
+
end
|
1165
|
+
|
958
1166
|
sig do
|
959
|
-
override
|
960
|
-
|
961
|
-
|
962
|
-
|
963
|
-
|
964
|
-
|
965
|
-
|
966
|
-
|
967
|
-
|
968
|
-
|
969
|
-
|
1167
|
+
override.returns(
|
1168
|
+
{
|
1169
|
+
amount_discount: String,
|
1170
|
+
applies_to_price_ids: T::Array[String],
|
1171
|
+
applies_to_price_interval_ids: T::Array[String],
|
1172
|
+
discount_type: Symbol,
|
1173
|
+
end_date: T.nilable(Time),
|
1174
|
+
start_date: Time
|
1175
|
+
}
|
1176
|
+
)
|
1177
|
+
end
|
1178
|
+
def to_hash
|
970
1179
|
end
|
971
|
-
def to_hash; end
|
972
1180
|
end
|
973
1181
|
|
974
1182
|
class Percentage < Orb::Internal::Type::BaseModel
|
1183
|
+
OrHash =
|
1184
|
+
T.type_alias do
|
1185
|
+
T.any(
|
1186
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage,
|
1187
|
+
Orb::Internal::AnyHash
|
1188
|
+
)
|
1189
|
+
end
|
1190
|
+
|
975
1191
|
# The price ids that this discount interval applies to.
|
976
1192
|
sig { returns(T::Array[String]) }
|
977
1193
|
attr_accessor :applies_to_price_ids
|
@@ -1004,8 +1220,7 @@ module Orb
|
|
1004
1220
|
percentage_discount: Float,
|
1005
1221
|
start_date: Time,
|
1006
1222
|
discount_type: Symbol
|
1007
|
-
)
|
1008
|
-
.returns(T.attached_class)
|
1223
|
+
).returns(T.attached_class)
|
1009
1224
|
end
|
1010
1225
|
def self.new(
|
1011
1226
|
# The price ids that this discount interval applies to.
|
@@ -1020,24 +1235,34 @@ module Orb
|
|
1020
1235
|
# The start date of the discount interval.
|
1021
1236
|
start_date:,
|
1022
1237
|
discount_type: :percentage
|
1023
|
-
)
|
1238
|
+
)
|
1239
|
+
end
|
1240
|
+
|
1024
1241
|
sig do
|
1025
|
-
override
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
|
1030
|
-
|
1031
|
-
|
1032
|
-
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1242
|
+
override.returns(
|
1243
|
+
{
|
1244
|
+
applies_to_price_ids: T::Array[String],
|
1245
|
+
applies_to_price_interval_ids: T::Array[String],
|
1246
|
+
discount_type: Symbol,
|
1247
|
+
end_date: T.nilable(Time),
|
1248
|
+
percentage_discount: Float,
|
1249
|
+
start_date: Time
|
1250
|
+
}
|
1251
|
+
)
|
1252
|
+
end
|
1253
|
+
def to_hash
|
1036
1254
|
end
|
1037
|
-
def to_hash; end
|
1038
1255
|
end
|
1039
1256
|
|
1040
1257
|
class Usage < Orb::Internal::Type::BaseModel
|
1258
|
+
OrHash =
|
1259
|
+
T.type_alias do
|
1260
|
+
T.any(
|
1261
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage,
|
1262
|
+
Orb::Internal::AnyHash
|
1263
|
+
)
|
1264
|
+
end
|
1265
|
+
|
1041
1266
|
# The price ids that this discount interval applies to.
|
1042
1267
|
sig { returns(T::Array[String]) }
|
1043
1268
|
attr_accessor :applies_to_price_ids
|
@@ -1070,8 +1295,7 @@ module Orb
|
|
1070
1295
|
start_date: Time,
|
1071
1296
|
usage_discount: Float,
|
1072
1297
|
discount_type: Symbol
|
1073
|
-
)
|
1074
|
-
.returns(T.attached_class)
|
1298
|
+
).returns(T.attached_class)
|
1075
1299
|
end
|
1076
1300
|
def self.new(
|
1077
1301
|
# The price ids that this discount interval applies to.
|
@@ -1086,33 +1310,45 @@ module Orb
|
|
1086
1310
|
# discount is for
|
1087
1311
|
usage_discount:,
|
1088
1312
|
discount_type: :usage
|
1089
|
-
)
|
1313
|
+
)
|
1314
|
+
end
|
1315
|
+
|
1090
1316
|
sig do
|
1091
|
-
override
|
1092
|
-
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1317
|
+
override.returns(
|
1318
|
+
{
|
1319
|
+
applies_to_price_ids: T::Array[String],
|
1320
|
+
applies_to_price_interval_ids: T::Array[String],
|
1321
|
+
discount_type: Symbol,
|
1322
|
+
end_date: T.nilable(Time),
|
1323
|
+
start_date: Time,
|
1324
|
+
usage_discount: Float
|
1325
|
+
}
|
1326
|
+
)
|
1327
|
+
end
|
1328
|
+
def to_hash
|
1102
1329
|
end
|
1103
|
-
def to_hash; end
|
1104
1330
|
end
|
1105
1331
|
|
1106
1332
|
sig do
|
1107
|
-
override
|
1108
|
-
|
1109
|
-
|
1110
|
-
|
1333
|
+
override.returns(
|
1334
|
+
T::Array[
|
1335
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Variants
|
1336
|
+
]
|
1337
|
+
)
|
1338
|
+
end
|
1339
|
+
def self.variants
|
1111
1340
|
end
|
1112
|
-
def self.variants; end
|
1113
1341
|
end
|
1114
1342
|
|
1115
1343
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
1344
|
+
OrHash =
|
1345
|
+
T.type_alias do
|
1346
|
+
T.any(
|
1347
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule,
|
1348
|
+
Orb::Internal::AnyHash
|
1349
|
+
)
|
1350
|
+
end
|
1351
|
+
|
1116
1352
|
sig { returns(T.nilable(Time)) }
|
1117
1353
|
attr_accessor :end_date
|
1118
1354
|
|
@@ -1126,18 +1362,39 @@ module Orb
|
|
1126
1362
|
attr_accessor :start_date
|
1127
1363
|
|
1128
1364
|
sig do
|
1129
|
-
params(
|
1130
|
-
.
|
1365
|
+
params(
|
1366
|
+
end_date: T.nilable(Time),
|
1367
|
+
price_id: String,
|
1368
|
+
quantity: Float,
|
1369
|
+
start_date: Time
|
1370
|
+
).returns(T.attached_class)
|
1371
|
+
end
|
1372
|
+
def self.new(end_date:, price_id:, quantity:, start_date:)
|
1131
1373
|
end
|
1132
|
-
def self.new(end_date:, price_id:, quantity:, start_date:); end
|
1133
1374
|
|
1134
1375
|
sig do
|
1135
|
-
override.returns(
|
1376
|
+
override.returns(
|
1377
|
+
{
|
1378
|
+
end_date: T.nilable(Time),
|
1379
|
+
price_id: String,
|
1380
|
+
quantity: Float,
|
1381
|
+
start_date: Time
|
1382
|
+
}
|
1383
|
+
)
|
1384
|
+
end
|
1385
|
+
def to_hash
|
1136
1386
|
end
|
1137
|
-
def to_hash; end
|
1138
1387
|
end
|
1139
1388
|
|
1140
1389
|
class MaximumInterval < Orb::Internal::Type::BaseModel
|
1390
|
+
OrHash =
|
1391
|
+
T.type_alias do
|
1392
|
+
T.any(
|
1393
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval,
|
1394
|
+
Orb::Internal::AnyHash
|
1395
|
+
)
|
1396
|
+
end
|
1397
|
+
|
1141
1398
|
# The price ids that this maximum interval applies to.
|
1142
1399
|
sig { returns(T::Array[String]) }
|
1143
1400
|
attr_accessor :applies_to_price_ids
|
@@ -1166,8 +1423,7 @@ module Orb
|
|
1166
1423
|
end_date: T.nilable(Time),
|
1167
1424
|
maximum_amount: String,
|
1168
1425
|
start_date: Time
|
1169
|
-
)
|
1170
|
-
.returns(T.attached_class)
|
1426
|
+
).returns(T.attached_class)
|
1171
1427
|
end
|
1172
1428
|
def self.new(
|
1173
1429
|
# The price ids that this maximum interval applies to.
|
@@ -1181,23 +1437,33 @@ module Orb
|
|
1181
1437
|
maximum_amount:,
|
1182
1438
|
# The start date of the maximum interval.
|
1183
1439
|
start_date:
|
1184
|
-
)
|
1440
|
+
)
|
1441
|
+
end
|
1442
|
+
|
1185
1443
|
sig do
|
1186
|
-
override
|
1187
|
-
|
1188
|
-
|
1189
|
-
|
1190
|
-
|
1191
|
-
|
1192
|
-
|
1193
|
-
|
1194
|
-
|
1195
|
-
|
1444
|
+
override.returns(
|
1445
|
+
{
|
1446
|
+
applies_to_price_ids: T::Array[String],
|
1447
|
+
applies_to_price_interval_ids: T::Array[String],
|
1448
|
+
end_date: T.nilable(Time),
|
1449
|
+
maximum_amount: String,
|
1450
|
+
start_date: Time
|
1451
|
+
}
|
1452
|
+
)
|
1453
|
+
end
|
1454
|
+
def to_hash
|
1196
1455
|
end
|
1197
|
-
def to_hash; end
|
1198
1456
|
end
|
1199
1457
|
|
1200
1458
|
class MinimumInterval < Orb::Internal::Type::BaseModel
|
1459
|
+
OrHash =
|
1460
|
+
T.type_alias do
|
1461
|
+
T.any(
|
1462
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval,
|
1463
|
+
Orb::Internal::AnyHash
|
1464
|
+
)
|
1465
|
+
end
|
1466
|
+
|
1201
1467
|
# The price ids that this minimum interval applies to.
|
1202
1468
|
sig { returns(T::Array[String]) }
|
1203
1469
|
attr_accessor :applies_to_price_ids
|
@@ -1226,8 +1492,7 @@ module Orb
|
|
1226
1492
|
end_date: T.nilable(Time),
|
1227
1493
|
minimum_amount: String,
|
1228
1494
|
start_date: Time
|
1229
|
-
)
|
1230
|
-
.returns(T.attached_class)
|
1495
|
+
).returns(T.attached_class)
|
1231
1496
|
end
|
1232
1497
|
def self.new(
|
1233
1498
|
# The price ids that this minimum interval applies to.
|
@@ -1241,35 +1506,55 @@ module Orb
|
|
1241
1506
|
minimum_amount:,
|
1242
1507
|
# The start date of the minimum interval.
|
1243
1508
|
start_date:
|
1244
|
-
)
|
1509
|
+
)
|
1510
|
+
end
|
1511
|
+
|
1245
1512
|
sig do
|
1246
|
-
override
|
1247
|
-
|
1248
|
-
|
1249
|
-
|
1250
|
-
|
1251
|
-
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1255
|
-
|
1513
|
+
override.returns(
|
1514
|
+
{
|
1515
|
+
applies_to_price_ids: T::Array[String],
|
1516
|
+
applies_to_price_interval_ids: T::Array[String],
|
1517
|
+
end_date: T.nilable(Time),
|
1518
|
+
minimum_amount: String,
|
1519
|
+
start_date: Time
|
1520
|
+
}
|
1521
|
+
)
|
1522
|
+
end
|
1523
|
+
def to_hash
|
1256
1524
|
end
|
1257
|
-
def to_hash; end
|
1258
1525
|
end
|
1259
1526
|
|
1260
1527
|
class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
|
1528
|
+
OrHash =
|
1529
|
+
T.type_alias do
|
1530
|
+
T.any(
|
1531
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange,
|
1532
|
+
Orb::Internal::AnyHash
|
1533
|
+
)
|
1534
|
+
end
|
1535
|
+
|
1261
1536
|
sig { returns(String) }
|
1262
1537
|
attr_accessor :id
|
1263
1538
|
|
1264
1539
|
# A pending subscription change if one exists on this subscription.
|
1265
1540
|
sig { params(id: String).returns(T.attached_class) }
|
1266
|
-
def self.new(id:)
|
1541
|
+
def self.new(id:)
|
1542
|
+
end
|
1267
1543
|
|
1268
|
-
sig { override.returns({id: String}) }
|
1269
|
-
def to_hash
|
1544
|
+
sig { override.returns({ id: String }) }
|
1545
|
+
def to_hash
|
1546
|
+
end
|
1270
1547
|
end
|
1271
1548
|
|
1272
1549
|
class PriceInterval < Orb::Internal::Type::BaseModel
|
1550
|
+
OrHash =
|
1551
|
+
T.type_alias do
|
1552
|
+
T.any(
|
1553
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval,
|
1554
|
+
Orb::Internal::AnyHash
|
1555
|
+
)
|
1556
|
+
end
|
1557
|
+
|
1273
1558
|
sig { returns(String) }
|
1274
1559
|
attr_accessor :id
|
1275
1560
|
|
@@ -1303,7 +1588,9 @@ module Orb
|
|
1303
1588
|
sig do
|
1304
1589
|
returns(
|
1305
1590
|
T.nilable(
|
1306
|
-
T::Array[
|
1591
|
+
T::Array[
|
1592
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition
|
1593
|
+
]
|
1307
1594
|
)
|
1308
1595
|
)
|
1309
1596
|
end
|
@@ -1322,34 +1609,34 @@ module Orb
|
|
1322
1609
|
sig do
|
1323
1610
|
returns(
|
1324
1611
|
T.any(
|
1325
|
-
Orb::
|
1326
|
-
Orb::
|
1327
|
-
Orb::
|
1328
|
-
Orb::
|
1329
|
-
Orb::
|
1330
|
-
Orb::
|
1331
|
-
Orb::
|
1332
|
-
Orb::
|
1333
|
-
Orb::
|
1334
|
-
Orb::
|
1335
|
-
Orb::
|
1336
|
-
Orb::
|
1337
|
-
Orb::
|
1338
|
-
Orb::
|
1339
|
-
Orb::
|
1340
|
-
Orb::
|
1341
|
-
Orb::
|
1342
|
-
Orb::
|
1343
|
-
Orb::
|
1344
|
-
Orb::
|
1345
|
-
Orb::
|
1346
|
-
Orb::
|
1347
|
-
Orb::
|
1348
|
-
Orb::
|
1349
|
-
Orb::
|
1350
|
-
Orb::
|
1351
|
-
Orb::
|
1352
|
-
Orb::
|
1612
|
+
Orb::Price::Unit,
|
1613
|
+
Orb::Price::Package,
|
1614
|
+
Orb::Price::Matrix,
|
1615
|
+
Orb::Price::Tiered,
|
1616
|
+
Orb::Price::TieredBps,
|
1617
|
+
Orb::Price::Bps,
|
1618
|
+
Orb::Price::BulkBps,
|
1619
|
+
Orb::Price::Bulk,
|
1620
|
+
Orb::Price::ThresholdTotalAmount,
|
1621
|
+
Orb::Price::TieredPackage,
|
1622
|
+
Orb::Price::GroupedTiered,
|
1623
|
+
Orb::Price::TieredWithMinimum,
|
1624
|
+
Orb::Price::TieredPackageWithMinimum,
|
1625
|
+
Orb::Price::PackageWithAllocation,
|
1626
|
+
Orb::Price::UnitWithPercent,
|
1627
|
+
Orb::Price::MatrixWithAllocation,
|
1628
|
+
Orb::Price::TieredWithProration,
|
1629
|
+
Orb::Price::UnitWithProration,
|
1630
|
+
Orb::Price::GroupedAllocation,
|
1631
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1632
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1633
|
+
Orb::Price::MatrixWithDisplayName,
|
1634
|
+
Orb::Price::BulkWithProration,
|
1635
|
+
Orb::Price::GroupedTieredPackage,
|
1636
|
+
Orb::Price::MaxGroupTieredPackage,
|
1637
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1638
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1639
|
+
Orb::Price::CumulativeGroupedBulk
|
1353
1640
|
)
|
1354
1641
|
)
|
1355
1642
|
end
|
@@ -1376,49 +1663,46 @@ module Orb
|
|
1376
1663
|
current_billing_period_start_date: T.nilable(Time),
|
1377
1664
|
end_date: T.nilable(Time),
|
1378
1665
|
filter: T.nilable(String),
|
1379
|
-
fixed_fee_quantity_transitions:
|
1380
|
-
T
|
1381
|
-
T
|
1382
|
-
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition
|
1383
|
-
|
1384
|
-
|
1385
|
-
|
1386
|
-
|
1387
|
-
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
|
1392
|
-
|
1393
|
-
|
1394
|
-
|
1395
|
-
|
1396
|
-
|
1397
|
-
|
1398
|
-
|
1399
|
-
|
1400
|
-
|
1401
|
-
|
1402
|
-
|
1403
|
-
|
1404
|
-
|
1405
|
-
|
1406
|
-
|
1407
|
-
|
1408
|
-
|
1409
|
-
|
1410
|
-
|
1411
|
-
|
1412
|
-
|
1413
|
-
|
1414
|
-
|
1415
|
-
|
1416
|
-
Orb::Models::Price::CumulativeGroupedBulk
|
1417
|
-
),
|
1666
|
+
fixed_fee_quantity_transitions:
|
1667
|
+
T.nilable(
|
1668
|
+
T::Array[
|
1669
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition::OrHash
|
1670
|
+
]
|
1671
|
+
),
|
1672
|
+
price:
|
1673
|
+
T.any(
|
1674
|
+
Orb::Price::Unit::OrHash,
|
1675
|
+
Orb::Price::Package::OrHash,
|
1676
|
+
Orb::Price::Matrix::OrHash,
|
1677
|
+
Orb::Price::Tiered::OrHash,
|
1678
|
+
Orb::Price::TieredBps::OrHash,
|
1679
|
+
Orb::Price::Bps::OrHash,
|
1680
|
+
Orb::Price::BulkBps::OrHash,
|
1681
|
+
Orb::Price::Bulk::OrHash,
|
1682
|
+
Orb::Price::ThresholdTotalAmount::OrHash,
|
1683
|
+
Orb::Price::TieredPackage::OrHash,
|
1684
|
+
Orb::Price::GroupedTiered::OrHash,
|
1685
|
+
Orb::Price::TieredWithMinimum::OrHash,
|
1686
|
+
Orb::Price::TieredPackageWithMinimum::OrHash,
|
1687
|
+
Orb::Price::PackageWithAllocation::OrHash,
|
1688
|
+
Orb::Price::UnitWithPercent::OrHash,
|
1689
|
+
Orb::Price::MatrixWithAllocation::OrHash,
|
1690
|
+
Orb::Price::TieredWithProration::OrHash,
|
1691
|
+
Orb::Price::UnitWithProration::OrHash,
|
1692
|
+
Orb::Price::GroupedAllocation::OrHash,
|
1693
|
+
Orb::Price::GroupedWithProratedMinimum::OrHash,
|
1694
|
+
Orb::Price::GroupedWithMeteredMinimum::OrHash,
|
1695
|
+
Orb::Price::MatrixWithDisplayName::OrHash,
|
1696
|
+
Orb::Price::BulkWithProration::OrHash,
|
1697
|
+
Orb::Price::GroupedTieredPackage::OrHash,
|
1698
|
+
Orb::Price::MaxGroupTieredPackage::OrHash,
|
1699
|
+
Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
|
1700
|
+
Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
|
1701
|
+
Orb::Price::CumulativeGroupedBulk::OrHash
|
1702
|
+
),
|
1418
1703
|
start_date: Time,
|
1419
1704
|
usage_customer_ids: T.nilable(T::Array[String])
|
1420
|
-
)
|
1421
|
-
.returns(T.attached_class)
|
1705
|
+
).returns(T.attached_class)
|
1422
1706
|
end
|
1423
1707
|
def self.new(
|
1424
1708
|
id:,
|
@@ -1457,58 +1741,72 @@ module Orb
|
|
1457
1741
|
# A list of customer IDs whose usage events will be aggregated and billed under
|
1458
1742
|
# this price interval.
|
1459
1743
|
usage_customer_ids:
|
1460
|
-
)
|
1744
|
+
)
|
1745
|
+
end
|
1746
|
+
|
1461
1747
|
sig do
|
1462
|
-
override
|
1463
|
-
|
1464
|
-
|
1465
|
-
|
1466
|
-
|
1467
|
-
|
1468
|
-
|
1469
|
-
|
1470
|
-
|
1471
|
-
|
1472
|
-
T::Array[
|
1748
|
+
override.returns(
|
1749
|
+
{
|
1750
|
+
id: String,
|
1751
|
+
billing_cycle_day: Integer,
|
1752
|
+
current_billing_period_end_date: T.nilable(Time),
|
1753
|
+
current_billing_period_start_date: T.nilable(Time),
|
1754
|
+
end_date: T.nilable(Time),
|
1755
|
+
filter: T.nilable(String),
|
1756
|
+
fixed_fee_quantity_transitions:
|
1757
|
+
T.nilable(
|
1758
|
+
T::Array[
|
1759
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition
|
1760
|
+
]
|
1473
1761
|
),
|
1474
|
-
|
1475
|
-
|
1476
|
-
Orb::
|
1477
|
-
Orb::
|
1478
|
-
Orb::
|
1479
|
-
Orb::
|
1480
|
-
Orb::
|
1481
|
-
Orb::
|
1482
|
-
Orb::
|
1483
|
-
Orb::
|
1484
|
-
Orb::
|
1485
|
-
Orb::
|
1486
|
-
Orb::
|
1487
|
-
Orb::
|
1488
|
-
Orb::
|
1489
|
-
Orb::
|
1490
|
-
Orb::
|
1491
|
-
Orb::
|
1492
|
-
Orb::
|
1493
|
-
Orb::
|
1494
|
-
Orb::
|
1495
|
-
Orb::
|
1496
|
-
Orb::
|
1497
|
-
Orb::
|
1498
|
-
Orb::
|
1499
|
-
Orb::
|
1500
|
-
Orb::
|
1501
|
-
Orb::
|
1502
|
-
Orb::
|
1762
|
+
price:
|
1763
|
+
T.any(
|
1764
|
+
Orb::Price::Unit,
|
1765
|
+
Orb::Price::Package,
|
1766
|
+
Orb::Price::Matrix,
|
1767
|
+
Orb::Price::Tiered,
|
1768
|
+
Orb::Price::TieredBps,
|
1769
|
+
Orb::Price::Bps,
|
1770
|
+
Orb::Price::BulkBps,
|
1771
|
+
Orb::Price::Bulk,
|
1772
|
+
Orb::Price::ThresholdTotalAmount,
|
1773
|
+
Orb::Price::TieredPackage,
|
1774
|
+
Orb::Price::GroupedTiered,
|
1775
|
+
Orb::Price::TieredWithMinimum,
|
1776
|
+
Orb::Price::TieredPackageWithMinimum,
|
1777
|
+
Orb::Price::PackageWithAllocation,
|
1778
|
+
Orb::Price::UnitWithPercent,
|
1779
|
+
Orb::Price::MatrixWithAllocation,
|
1780
|
+
Orb::Price::TieredWithProration,
|
1781
|
+
Orb::Price::UnitWithProration,
|
1782
|
+
Orb::Price::GroupedAllocation,
|
1783
|
+
Orb::Price::GroupedWithProratedMinimum,
|
1784
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
1785
|
+
Orb::Price::MatrixWithDisplayName,
|
1786
|
+
Orb::Price::BulkWithProration,
|
1787
|
+
Orb::Price::GroupedTieredPackage,
|
1788
|
+
Orb::Price::MaxGroupTieredPackage,
|
1789
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
1790
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
1791
|
+
Orb::Price::CumulativeGroupedBulk
|
1503
1792
|
),
|
1504
|
-
|
1505
|
-
|
1506
|
-
|
1507
|
-
|
1793
|
+
start_date: Time,
|
1794
|
+
usage_customer_ids: T.nilable(T::Array[String])
|
1795
|
+
}
|
1796
|
+
)
|
1797
|
+
end
|
1798
|
+
def to_hash
|
1508
1799
|
end
|
1509
|
-
def to_hash; end
|
1510
1800
|
|
1511
1801
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
1802
|
+
OrHash =
|
1803
|
+
T.type_alias do
|
1804
|
+
T.any(
|
1805
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition,
|
1806
|
+
Orb::Internal::AnyHash
|
1807
|
+
)
|
1808
|
+
end
|
1809
|
+
|
1512
1810
|
sig { returns(Time) }
|
1513
1811
|
attr_accessor :effective_date
|
1514
1812
|
|
@@ -1518,15 +1816,35 @@ module Orb
|
|
1518
1816
|
sig { returns(Integer) }
|
1519
1817
|
attr_accessor :quantity
|
1520
1818
|
|
1521
|
-
sig
|
1522
|
-
|
1819
|
+
sig do
|
1820
|
+
params(
|
1821
|
+
effective_date: Time,
|
1822
|
+
price_id: String,
|
1823
|
+
quantity: Integer
|
1824
|
+
).returns(T.attached_class)
|
1825
|
+
end
|
1826
|
+
def self.new(effective_date:, price_id:, quantity:)
|
1827
|
+
end
|
1523
1828
|
|
1524
|
-
sig
|
1525
|
-
|
1829
|
+
sig do
|
1830
|
+
override.returns(
|
1831
|
+
{ effective_date: Time, price_id: String, quantity: Integer }
|
1832
|
+
)
|
1833
|
+
end
|
1834
|
+
def to_hash
|
1835
|
+
end
|
1526
1836
|
end
|
1527
1837
|
end
|
1528
1838
|
|
1529
1839
|
class RedeemedCoupon < Orb::Internal::Type::BaseModel
|
1840
|
+
OrHash =
|
1841
|
+
T.type_alias do
|
1842
|
+
T.any(
|
1843
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon,
|
1844
|
+
Orb::Internal::AnyHash
|
1845
|
+
)
|
1846
|
+
end
|
1847
|
+
|
1530
1848
|
sig { returns(String) }
|
1531
1849
|
attr_accessor :coupon_id
|
1532
1850
|
|
@@ -1537,55 +1855,107 @@ module Orb
|
|
1537
1855
|
attr_accessor :start_date
|
1538
1856
|
|
1539
1857
|
sig do
|
1540
|
-
params(
|
1858
|
+
params(
|
1859
|
+
coupon_id: String,
|
1860
|
+
end_date: T.nilable(Time),
|
1861
|
+
start_date: Time
|
1862
|
+
).returns(T.attached_class)
|
1863
|
+
end
|
1864
|
+
def self.new(coupon_id:, end_date:, start_date:)
|
1541
1865
|
end
|
1542
|
-
def self.new(coupon_id:, end_date:, start_date:); end
|
1543
1866
|
|
1544
|
-
sig
|
1545
|
-
|
1867
|
+
sig do
|
1868
|
+
override.returns(
|
1869
|
+
{ coupon_id: String, end_date: T.nilable(Time), start_date: Time }
|
1870
|
+
)
|
1871
|
+
end
|
1872
|
+
def to_hash
|
1873
|
+
end
|
1546
1874
|
end
|
1547
1875
|
|
1548
1876
|
module Status
|
1549
1877
|
extend Orb::Internal::Type::Enum
|
1550
1878
|
|
1551
1879
|
TaggedSymbol =
|
1552
|
-
T.type_alias
|
1880
|
+
T.type_alias do
|
1881
|
+
T.all(
|
1882
|
+
Symbol,
|
1883
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status
|
1884
|
+
)
|
1885
|
+
end
|
1553
1886
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1554
1887
|
|
1555
|
-
ACTIVE =
|
1556
|
-
|
1557
|
-
|
1888
|
+
ACTIVE =
|
1889
|
+
T.let(
|
1890
|
+
:active,
|
1891
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
1892
|
+
)
|
1893
|
+
ENDED =
|
1894
|
+
T.let(
|
1895
|
+
:ended,
|
1896
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
1897
|
+
)
|
1898
|
+
UPCOMING =
|
1899
|
+
T.let(
|
1900
|
+
:upcoming,
|
1901
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
1902
|
+
)
|
1558
1903
|
|
1559
|
-
sig
|
1560
|
-
|
1904
|
+
sig do
|
1905
|
+
override.returns(
|
1906
|
+
T::Array[
|
1907
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
|
1908
|
+
]
|
1909
|
+
)
|
1910
|
+
end
|
1911
|
+
def self.values
|
1912
|
+
end
|
1561
1913
|
end
|
1562
1914
|
|
1563
1915
|
class TrialInfo < Orb::Internal::Type::BaseModel
|
1916
|
+
OrHash =
|
1917
|
+
T.type_alias do
|
1918
|
+
T.any(
|
1919
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo,
|
1920
|
+
Orb::Internal::AnyHash
|
1921
|
+
)
|
1922
|
+
end
|
1923
|
+
|
1564
1924
|
sig { returns(T.nilable(Time)) }
|
1565
1925
|
attr_accessor :end_date
|
1566
1926
|
|
1567
1927
|
sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
|
1568
|
-
def self.new(end_date:)
|
1928
|
+
def self.new(end_date:)
|
1929
|
+
end
|
1569
1930
|
|
1570
|
-
sig { override.returns({end_date: T.nilable(Time)}) }
|
1571
|
-
def to_hash
|
1931
|
+
sig { override.returns({ end_date: T.nilable(Time) }) }
|
1932
|
+
def to_hash
|
1933
|
+
end
|
1572
1934
|
end
|
1573
1935
|
|
1574
1936
|
class ChangedResources < Orb::Internal::Type::BaseModel
|
1937
|
+
OrHash =
|
1938
|
+
T.type_alias do
|
1939
|
+
T.any(
|
1940
|
+
Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources,
|
1941
|
+
Orb::Internal::AnyHash
|
1942
|
+
)
|
1943
|
+
end
|
1944
|
+
|
1575
1945
|
# The credit notes that were created as part of this operation.
|
1576
|
-
sig { returns(T::Array[Orb::
|
1946
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1577
1947
|
attr_accessor :created_credit_notes
|
1578
1948
|
|
1579
1949
|
# The invoices that were created as part of this operation.
|
1580
|
-
sig { returns(T::Array[Orb::
|
1950
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1581
1951
|
attr_accessor :created_invoices
|
1582
1952
|
|
1583
1953
|
# The credit notes that were voided as part of this operation.
|
1584
|
-
sig { returns(T::Array[Orb::
|
1954
|
+
sig { returns(T::Array[Orb::CreditNote]) }
|
1585
1955
|
attr_accessor :voided_credit_notes
|
1586
1956
|
|
1587
1957
|
# The invoices that were voided as part of this operation.
|
1588
|
-
sig { returns(T::Array[Orb::
|
1958
|
+
sig { returns(T::Array[Orb::Invoice]) }
|
1589
1959
|
attr_accessor :voided_invoices
|
1590
1960
|
|
1591
1961
|
# The resources that were changed as part of this operation. Only present when
|
@@ -1593,12 +1963,11 @@ module Orb
|
|
1593
1963
|
# `include_changed_resources` parameter was passed in the request.
|
1594
1964
|
sig do
|
1595
1965
|
params(
|
1596
|
-
created_credit_notes: T::Array[
|
1597
|
-
created_invoices: T::Array[
|
1598
|
-
voided_credit_notes: T::Array[
|
1599
|
-
voided_invoices: T::Array[
|
1600
|
-
)
|
1601
|
-
.returns(T.attached_class)
|
1966
|
+
created_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1967
|
+
created_invoices: T::Array[Orb::Invoice::OrHash],
|
1968
|
+
voided_credit_notes: T::Array[Orb::CreditNote::OrHash],
|
1969
|
+
voided_invoices: T::Array[Orb::Invoice::OrHash]
|
1970
|
+
).returns(T.attached_class)
|
1602
1971
|
end
|
1603
1972
|
def self.new(
|
1604
1973
|
# The credit notes that were created as part of this operation.
|
@@ -1609,19 +1978,21 @@ module Orb
|
|
1609
1978
|
voided_credit_notes:,
|
1610
1979
|
# The invoices that were voided as part of this operation.
|
1611
1980
|
voided_invoices:
|
1612
|
-
)
|
1981
|
+
)
|
1982
|
+
end
|
1983
|
+
|
1613
1984
|
sig do
|
1614
|
-
override
|
1615
|
-
|
1616
|
-
|
1617
|
-
|
1618
|
-
|
1619
|
-
|
1620
|
-
|
1621
|
-
|
1622
|
-
|
1985
|
+
override.returns(
|
1986
|
+
{
|
1987
|
+
created_credit_notes: T::Array[Orb::CreditNote],
|
1988
|
+
created_invoices: T::Array[Orb::Invoice],
|
1989
|
+
voided_credit_notes: T::Array[Orb::CreditNote],
|
1990
|
+
voided_invoices: T::Array[Orb::Invoice]
|
1991
|
+
}
|
1992
|
+
)
|
1993
|
+
end
|
1994
|
+
def to_hash
|
1623
1995
|
end
|
1624
|
-
def to_hash; end
|
1625
1996
|
end
|
1626
1997
|
end
|
1627
1998
|
end
|