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
data/lib/orb/models/plan.rb
CHANGED
@@ -13,13 +13,13 @@ module Orb
|
|
13
13
|
# Adjustments for this plan. If the plan has phases, this includes adjustments
|
14
14
|
# across all phases of the plan.
|
15
15
|
#
|
16
|
-
# @return [Array<Orb::
|
17
|
-
required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::
|
16
|
+
# @return [Array<Orb::Plan::Adjustment::UsageDiscount, Orb::Plan::Adjustment::AmountDiscount, Orb::Plan::Adjustment::PercentageDiscount, Orb::Plan::Adjustment::Minimum, Orb::Plan::Adjustment::Maximum>]
|
17
|
+
required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Plan::Adjustment] }
|
18
18
|
|
19
19
|
# @!attribute base_plan
|
20
20
|
#
|
21
|
-
# @return [Orb::
|
22
|
-
required :base_plan, -> { Orb::
|
21
|
+
# @return [Orb::Plan::BasePlan, nil]
|
22
|
+
required :base_plan, -> { Orb::Plan::BasePlan }, nil?: true
|
23
23
|
|
24
24
|
# @!attribute base_plan_id
|
25
25
|
# The parent plan id if the given plan was created by overriding one or more of
|
@@ -56,8 +56,8 @@ module Orb
|
|
56
56
|
|
57
57
|
# @!attribute discount
|
58
58
|
#
|
59
|
-
# @return [Orb::
|
60
|
-
required :discount, union: -> { Orb::
|
59
|
+
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
60
|
+
required :discount, union: -> { Orb::Discount }, nil?: true
|
61
61
|
|
62
62
|
# @!attribute external_plan_id
|
63
63
|
# An optional user-defined ID for this plan resource, used throughout the system
|
@@ -76,8 +76,8 @@ module Orb
|
|
76
76
|
|
77
77
|
# @!attribute maximum
|
78
78
|
#
|
79
|
-
# @return [Orb::
|
80
|
-
required :maximum, -> { Orb::
|
79
|
+
# @return [Orb::Plan::Maximum, nil]
|
80
|
+
required :maximum, -> { Orb::Plan::Maximum }, nil?: true
|
81
81
|
|
82
82
|
# @!attribute maximum_amount
|
83
83
|
#
|
@@ -95,8 +95,8 @@ module Orb
|
|
95
95
|
|
96
96
|
# @!attribute minimum
|
97
97
|
#
|
98
|
-
# @return [Orb::
|
99
|
-
required :minimum, -> { Orb::
|
98
|
+
# @return [Orb::Plan::Minimum, nil]
|
99
|
+
required :minimum, -> { Orb::Plan::Minimum }, nil?: true
|
100
100
|
|
101
101
|
# @!attribute minimum_amount
|
102
102
|
#
|
@@ -120,30 +120,30 @@ module Orb
|
|
120
120
|
|
121
121
|
# @!attribute plan_phases
|
122
122
|
#
|
123
|
-
# @return [Array<Orb::
|
124
|
-
required :plan_phases, -> { Orb::Internal::Type::ArrayOf[Orb::
|
123
|
+
# @return [Array<Orb::Plan::PlanPhase>, nil]
|
124
|
+
required :plan_phases, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::PlanPhase] }, nil?: true
|
125
125
|
|
126
126
|
# @!attribute prices
|
127
127
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
128
128
|
# phases of the plan.
|
129
129
|
#
|
130
|
-
# @return [Array<Orb::
|
131
|
-
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::
|
130
|
+
# @return [Array<Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk>]
|
131
|
+
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }
|
132
132
|
|
133
133
|
# @!attribute product
|
134
134
|
#
|
135
|
-
# @return [Orb::
|
136
|
-
required :product, -> { Orb::
|
135
|
+
# @return [Orb::Plan::Product]
|
136
|
+
required :product, -> { Orb::Plan::Product }
|
137
137
|
|
138
138
|
# @!attribute status
|
139
139
|
#
|
140
|
-
# @return [Symbol, Orb::
|
141
|
-
required :status, enum: -> { Orb::
|
140
|
+
# @return [Symbol, Orb::Plan::Status]
|
141
|
+
required :status, enum: -> { Orb::Plan::Status }
|
142
142
|
|
143
143
|
# @!attribute trial_config
|
144
144
|
#
|
145
|
-
# @return [Orb::
|
146
|
-
required :trial_config, -> { Orb::
|
145
|
+
# @return [Orb::Plan::TrialConfig]
|
146
|
+
required :trial_config, -> { Orb::Plan::TrialConfig }
|
147
147
|
|
148
148
|
# @!attribute version
|
149
149
|
#
|
@@ -151,8 +151,8 @@ module Orb
|
|
151
151
|
required :version, Integer
|
152
152
|
|
153
153
|
# @!method initialize(id:, adjustments:, base_plan:, base_plan_id:, created_at:, currency:, default_invoice_memo:, description:, discount:, external_plan_id:, invoicing_currency:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, net_terms:, plan_phases:, prices:, product:, status:, trial_config:, version:)
|
154
|
-
# Some parameter documentations has been truncated, see {Orb::
|
155
|
-
#
|
154
|
+
# Some parameter documentations has been truncated, see {Orb::Plan} for more
|
155
|
+
# details.
|
156
156
|
#
|
157
157
|
# The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
158
158
|
# subscribed to by a customer. Plans define the billing behavior of the
|
@@ -161,58 +161,49 @@ module Orb
|
|
161
161
|
#
|
162
162
|
# @param id [String]
|
163
163
|
#
|
164
|
-
# @param adjustments [Array<Orb::
|
165
|
-
# ...
|
164
|
+
# @param adjustments [Array<Orb::Plan::Adjustment::UsageDiscount, Orb::Plan::Adjustment::AmountDiscount, Orb::Plan::Adjustment::PercentageDiscount, Orb::Plan::Adjustment::Minimum, Orb::Plan::Adjustment::Maximum>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
|
166
165
|
#
|
167
|
-
# @param base_plan [Orb::
|
166
|
+
# @param base_plan [Orb::Plan::BasePlan, nil]
|
168
167
|
#
|
169
168
|
# @param base_plan_id [String, nil] The parent plan id if the given plan was created by overriding one or more of th
|
170
|
-
# ...
|
171
169
|
#
|
172
170
|
# @param created_at [Time]
|
173
171
|
#
|
174
172
|
# @param currency [String] An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's p
|
175
|
-
# ...
|
176
173
|
#
|
177
174
|
# @param default_invoice_memo [String, nil] The default memo text on the invoices corresponding to subscriptions on this pla
|
178
|
-
# ...
|
179
175
|
#
|
180
176
|
# @param description [String]
|
181
177
|
#
|
182
|
-
# @param discount [Orb::
|
178
|
+
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
183
179
|
#
|
184
180
|
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
185
|
-
# ...
|
186
181
|
#
|
187
182
|
# @param invoicing_currency [String] An ISO 4217 currency string for which this plan is billed in. Matches `currency`
|
188
|
-
# ...
|
189
183
|
#
|
190
|
-
# @param maximum [Orb::
|
184
|
+
# @param maximum [Orb::Plan::Maximum, nil]
|
191
185
|
#
|
192
186
|
# @param maximum_amount [String, nil]
|
193
187
|
#
|
194
188
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
195
|
-
# ...
|
196
189
|
#
|
197
|
-
# @param minimum [Orb::
|
190
|
+
# @param minimum [Orb::Plan::Minimum, nil]
|
198
191
|
#
|
199
192
|
# @param minimum_amount [String, nil]
|
200
193
|
#
|
201
194
|
# @param name [String]
|
202
195
|
#
|
203
196
|
# @param net_terms [Integer, nil] Determines the difference between the invoice issue date and the due date. A val
|
204
|
-
# ...
|
205
197
|
#
|
206
|
-
# @param plan_phases [Array<Orb::
|
198
|
+
# @param plan_phases [Array<Orb::Plan::PlanPhase>, nil]
|
207
199
|
#
|
208
|
-
# @param prices [Array<Orb::
|
209
|
-
# ...
|
200
|
+
# @param prices [Array<Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
210
201
|
#
|
211
|
-
# @param product [Orb::
|
202
|
+
# @param product [Orb::Plan::Product]
|
212
203
|
#
|
213
|
-
# @param status [Symbol, Orb::
|
204
|
+
# @param status [Symbol, Orb::Plan::Status]
|
214
205
|
#
|
215
|
-
# @param trial_config [Orb::
|
206
|
+
# @param trial_config [Orb::Plan::TrialConfig]
|
216
207
|
#
|
217
208
|
# @param version [Integer]
|
218
209
|
|
@@ -221,15 +212,15 @@ module Orb
|
|
221
212
|
|
222
213
|
discriminator :adjustment_type
|
223
214
|
|
224
|
-
variant :usage_discount, -> { Orb::
|
215
|
+
variant :usage_discount, -> { Orb::Plan::Adjustment::UsageDiscount }
|
225
216
|
|
226
|
-
variant :amount_discount, -> { Orb::
|
217
|
+
variant :amount_discount, -> { Orb::Plan::Adjustment::AmountDiscount }
|
227
218
|
|
228
|
-
variant :percentage_discount, -> { Orb::
|
219
|
+
variant :percentage_discount, -> { Orb::Plan::Adjustment::PercentageDiscount }
|
229
220
|
|
230
|
-
variant :minimum, -> { Orb::
|
221
|
+
variant :minimum, -> { Orb::Plan::Adjustment::Minimum }
|
231
222
|
|
232
|
-
variant :maximum, -> { Orb::
|
223
|
+
variant :maximum, -> { Orb::Plan::Adjustment::Maximum }
|
233
224
|
|
234
225
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
235
226
|
# @!attribute id
|
@@ -276,21 +267,19 @@ module Orb
|
|
276
267
|
|
277
268
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
278
269
|
# Some parameter documentations has been truncated, see
|
279
|
-
# {Orb::
|
270
|
+
# {Orb::Plan::Adjustment::UsageDiscount} for more details.
|
280
271
|
#
|
281
272
|
# @param id [String]
|
282
273
|
#
|
283
274
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
284
275
|
#
|
285
276
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
286
|
-
# ...
|
287
277
|
#
|
288
278
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
289
279
|
#
|
290
280
|
# @param reason [String, nil] The reason for the adjustment.
|
291
281
|
#
|
292
282
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
293
|
-
# ...
|
294
283
|
#
|
295
284
|
# @param adjustment_type [Symbol, :usage_discount]
|
296
285
|
end
|
@@ -340,17 +329,15 @@ module Orb
|
|
340
329
|
|
341
330
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
342
331
|
# Some parameter documentations has been truncated, see
|
343
|
-
# {Orb::
|
332
|
+
# {Orb::Plan::Adjustment::AmountDiscount} for more details.
|
344
333
|
#
|
345
334
|
# @param id [String]
|
346
335
|
#
|
347
336
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
348
|
-
# ...
|
349
337
|
#
|
350
338
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
351
339
|
#
|
352
340
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
353
|
-
# ...
|
354
341
|
#
|
355
342
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
356
343
|
#
|
@@ -404,17 +391,15 @@ module Orb
|
|
404
391
|
|
405
392
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
406
393
|
# Some parameter documentations has been truncated, see
|
407
|
-
# {Orb::
|
394
|
+
# {Orb::Plan::Adjustment::PercentageDiscount} for more details.
|
408
395
|
#
|
409
396
|
# @param id [String]
|
410
397
|
#
|
411
398
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
412
399
|
#
|
413
400
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
414
|
-
# ...
|
415
401
|
#
|
416
402
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
417
|
-
# ...
|
418
403
|
#
|
419
404
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
420
405
|
#
|
@@ -474,19 +459,17 @@ module Orb
|
|
474
459
|
|
475
460
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
476
461
|
# Some parameter documentations has been truncated, see
|
477
|
-
# {Orb::
|
462
|
+
# {Orb::Plan::Adjustment::Minimum} for more details.
|
478
463
|
#
|
479
464
|
# @param id [String]
|
480
465
|
#
|
481
466
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
482
467
|
#
|
483
468
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
484
|
-
# ...
|
485
469
|
#
|
486
470
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
487
471
|
#
|
488
472
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
489
|
-
# ...
|
490
473
|
#
|
491
474
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
492
475
|
#
|
@@ -540,17 +523,15 @@ module Orb
|
|
540
523
|
|
541
524
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
542
525
|
# Some parameter documentations has been truncated, see
|
543
|
-
# {Orb::
|
526
|
+
# {Orb::Plan::Adjustment::Maximum} for more details.
|
544
527
|
#
|
545
528
|
# @param id [String]
|
546
529
|
#
|
547
530
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
548
531
|
#
|
549
532
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
550
|
-
# ...
|
551
533
|
#
|
552
534
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
553
|
-
# ...
|
554
535
|
#
|
555
536
|
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
556
537
|
#
|
@@ -560,10 +541,22 @@ module Orb
|
|
560
541
|
end
|
561
542
|
|
562
543
|
# @!method self.variants
|
563
|
-
# @return [Array(Orb::
|
544
|
+
# @return [Array(Orb::Plan::Adjustment::UsageDiscount, Orb::Plan::Adjustment::AmountDiscount, Orb::Plan::Adjustment::PercentageDiscount, Orb::Plan::Adjustment::Minimum, Orb::Plan::Adjustment::Maximum)]
|
545
|
+
|
546
|
+
define_sorbet_constant!(:Variants) do
|
547
|
+
T.type_alias do
|
548
|
+
T.any(
|
549
|
+
Orb::Plan::Adjustment::UsageDiscount,
|
550
|
+
Orb::Plan::Adjustment::AmountDiscount,
|
551
|
+
Orb::Plan::Adjustment::PercentageDiscount,
|
552
|
+
Orb::Plan::Adjustment::Minimum,
|
553
|
+
Orb::Plan::Adjustment::Maximum
|
554
|
+
)
|
555
|
+
end
|
556
|
+
end
|
564
557
|
end
|
565
558
|
|
566
|
-
# @see Orb::
|
559
|
+
# @see Orb::Plan#base_plan
|
567
560
|
class BasePlan < Orb::Internal::Type::BaseModel
|
568
561
|
# @!attribute id
|
569
562
|
#
|
@@ -584,18 +577,17 @@ module Orb
|
|
584
577
|
required :name, String, nil?: true
|
585
578
|
|
586
579
|
# @!method initialize(id:, external_plan_id:, name:)
|
587
|
-
# Some parameter documentations has been truncated, see
|
588
|
-
#
|
580
|
+
# Some parameter documentations has been truncated, see {Orb::Plan::BasePlan} for
|
581
|
+
# more details.
|
589
582
|
#
|
590
583
|
# @param id [String, nil]
|
591
584
|
#
|
592
585
|
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
593
|
-
# ...
|
594
586
|
#
|
595
587
|
# @param name [String, nil]
|
596
588
|
end
|
597
589
|
|
598
|
-
# @see Orb::
|
590
|
+
# @see Orb::Plan#maximum
|
599
591
|
class Maximum < Orb::Internal::Type::BaseModel
|
600
592
|
# @!attribute applies_to_price_ids
|
601
593
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -611,16 +603,15 @@ module Orb
|
|
611
603
|
required :maximum_amount, String
|
612
604
|
|
613
605
|
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
614
|
-
# Some parameter documentations has been truncated, see
|
615
|
-
#
|
606
|
+
# Some parameter documentations has been truncated, see {Orb::Plan::Maximum} for
|
607
|
+
# more details.
|
616
608
|
#
|
617
609
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
618
|
-
# ...
|
619
610
|
#
|
620
611
|
# @param maximum_amount [String] Maximum amount applied
|
621
612
|
end
|
622
613
|
|
623
|
-
# @see Orb::
|
614
|
+
# @see Orb::Plan#minimum
|
624
615
|
class Minimum < Orb::Internal::Type::BaseModel
|
625
616
|
# @!attribute applies_to_price_ids
|
626
617
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -636,11 +627,10 @@ module Orb
|
|
636
627
|
required :minimum_amount, String
|
637
628
|
|
638
629
|
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
639
|
-
# Some parameter documentations has been truncated, see
|
640
|
-
#
|
630
|
+
# Some parameter documentations has been truncated, see {Orb::Plan::Minimum} for
|
631
|
+
# more details.
|
641
632
|
#
|
642
633
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
643
|
-
# ...
|
644
634
|
#
|
645
635
|
# @param minimum_amount [String] Minimum amount applied
|
646
636
|
end
|
@@ -658,8 +648,8 @@ module Orb
|
|
658
648
|
|
659
649
|
# @!attribute discount
|
660
650
|
#
|
661
|
-
# @return [Orb::
|
662
|
-
required :discount, union: -> { Orb::
|
651
|
+
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
652
|
+
required :discount, union: -> { Orb::Discount }, nil?: true
|
663
653
|
|
664
654
|
# @!attribute duration
|
665
655
|
# How many terms of length `duration_unit` this phase is active for. If null, this
|
@@ -670,13 +660,13 @@ module Orb
|
|
670
660
|
|
671
661
|
# @!attribute duration_unit
|
672
662
|
#
|
673
|
-
# @return [Symbol, Orb::
|
674
|
-
required :duration_unit, enum: -> { Orb::
|
663
|
+
# @return [Symbol, Orb::Plan::PlanPhase::DurationUnit, nil]
|
664
|
+
required :duration_unit, enum: -> { Orb::Plan::PlanPhase::DurationUnit }, nil?: true
|
675
665
|
|
676
666
|
# @!attribute maximum
|
677
667
|
#
|
678
|
-
# @return [Orb::
|
679
|
-
required :maximum, -> { Orb::
|
668
|
+
# @return [Orb::Plan::PlanPhase::Maximum, nil]
|
669
|
+
required :maximum, -> { Orb::Plan::PlanPhase::Maximum }, nil?: true
|
680
670
|
|
681
671
|
# @!attribute maximum_amount
|
682
672
|
#
|
@@ -685,8 +675,8 @@ module Orb
|
|
685
675
|
|
686
676
|
# @!attribute minimum
|
687
677
|
#
|
688
|
-
# @return [Orb::
|
689
|
-
required :minimum, -> { Orb::
|
678
|
+
# @return [Orb::Plan::PlanPhase::Minimum, nil]
|
679
|
+
required :minimum, -> { Orb::Plan::PlanPhase::Minimum }, nil?: true
|
690
680
|
|
691
681
|
# @!attribute minimum_amount
|
692
682
|
#
|
@@ -705,25 +695,24 @@ module Orb
|
|
705
695
|
required :order, Integer
|
706
696
|
|
707
697
|
# @!method initialize(id:, description:, discount:, duration:, duration_unit:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, order:)
|
708
|
-
# Some parameter documentations has been truncated, see
|
709
|
-
#
|
698
|
+
# Some parameter documentations has been truncated, see {Orb::Plan::PlanPhase} for
|
699
|
+
# more details.
|
710
700
|
#
|
711
701
|
# @param id [String]
|
712
702
|
#
|
713
703
|
# @param description [String, nil]
|
714
704
|
#
|
715
|
-
# @param discount [Orb::
|
705
|
+
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
716
706
|
#
|
717
707
|
# @param duration [Integer, nil] How many terms of length `duration_unit` this phase is active for. If null, this
|
718
|
-
# ...
|
719
708
|
#
|
720
|
-
# @param duration_unit [Symbol, Orb::
|
709
|
+
# @param duration_unit [Symbol, Orb::Plan::PlanPhase::DurationUnit, nil]
|
721
710
|
#
|
722
|
-
# @param maximum [Orb::
|
711
|
+
# @param maximum [Orb::Plan::PlanPhase::Maximum, nil]
|
723
712
|
#
|
724
713
|
# @param maximum_amount [String, nil]
|
725
714
|
#
|
726
|
-
# @param minimum [Orb::
|
715
|
+
# @param minimum [Orb::Plan::PlanPhase::Minimum, nil]
|
727
716
|
#
|
728
717
|
# @param minimum_amount [String, nil]
|
729
718
|
#
|
@@ -731,7 +720,7 @@ module Orb
|
|
731
720
|
#
|
732
721
|
# @param order [Integer] Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
|
733
722
|
|
734
|
-
# @see Orb::
|
723
|
+
# @see Orb::Plan::PlanPhase#duration_unit
|
735
724
|
module DurationUnit
|
736
725
|
extend Orb::Internal::Type::Enum
|
737
726
|
|
@@ -745,7 +734,7 @@ module Orb
|
|
745
734
|
# @return [Array<Symbol>]
|
746
735
|
end
|
747
736
|
|
748
|
-
# @see Orb::
|
737
|
+
# @see Orb::Plan::PlanPhase#maximum
|
749
738
|
class Maximum < Orb::Internal::Type::BaseModel
|
750
739
|
# @!attribute applies_to_price_ids
|
751
740
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -762,15 +751,14 @@ module Orb
|
|
762
751
|
|
763
752
|
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
764
753
|
# Some parameter documentations has been truncated, see
|
765
|
-
# {Orb::
|
754
|
+
# {Orb::Plan::PlanPhase::Maximum} for more details.
|
766
755
|
#
|
767
756
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
768
|
-
# ...
|
769
757
|
#
|
770
758
|
# @param maximum_amount [String] Maximum amount applied
|
771
759
|
end
|
772
760
|
|
773
|
-
# @see Orb::
|
761
|
+
# @see Orb::Plan::PlanPhase#minimum
|
774
762
|
class Minimum < Orb::Internal::Type::BaseModel
|
775
763
|
# @!attribute applies_to_price_ids
|
776
764
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -787,16 +775,15 @@ module Orb
|
|
787
775
|
|
788
776
|
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
789
777
|
# Some parameter documentations has been truncated, see
|
790
|
-
# {Orb::
|
778
|
+
# {Orb::Plan::PlanPhase::Minimum} for more details.
|
791
779
|
#
|
792
780
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
793
|
-
# ...
|
794
781
|
#
|
795
782
|
# @param minimum_amount [String] Minimum amount applied
|
796
783
|
end
|
797
784
|
end
|
798
785
|
|
799
|
-
# @see Orb::
|
786
|
+
# @see Orb::Plan#product
|
800
787
|
class Product < Orb::Internal::Type::BaseModel
|
801
788
|
# @!attribute id
|
802
789
|
#
|
@@ -819,7 +806,7 @@ module Orb
|
|
819
806
|
# @param name [String]
|
820
807
|
end
|
821
808
|
|
822
|
-
# @see Orb::
|
809
|
+
# @see Orb::Plan#status
|
823
810
|
module Status
|
824
811
|
extend Orb::Internal::Type::Enum
|
825
812
|
|
@@ -831,7 +818,7 @@ module Orb
|
|
831
818
|
# @return [Array<Symbol>]
|
832
819
|
end
|
833
820
|
|
834
|
-
# @see Orb::
|
821
|
+
# @see Orb::Plan#trial_config
|
835
822
|
class TrialConfig < Orb::Internal::Type::BaseModel
|
836
823
|
# @!attribute trial_period
|
837
824
|
#
|
@@ -840,14 +827,14 @@ module Orb
|
|
840
827
|
|
841
828
|
# @!attribute trial_period_unit
|
842
829
|
#
|
843
|
-
# @return [Symbol, Orb::
|
844
|
-
required :trial_period_unit, enum: -> { Orb::
|
830
|
+
# @return [Symbol, Orb::Plan::TrialConfig::TrialPeriodUnit]
|
831
|
+
required :trial_period_unit, enum: -> { Orb::Plan::TrialConfig::TrialPeriodUnit }
|
845
832
|
|
846
833
|
# @!method initialize(trial_period:, trial_period_unit:)
|
847
834
|
# @param trial_period [Integer, nil]
|
848
|
-
# @param trial_period_unit [Symbol, Orb::
|
835
|
+
# @param trial_period_unit [Symbol, Orb::Plan::TrialConfig::TrialPeriodUnit]
|
849
836
|
|
850
|
-
# @see Orb::
|
837
|
+
# @see Orb::Plan::TrialConfig#trial_period_unit
|
851
838
|
module TrialPeriodUnit
|
852
839
|
extend Orb::Internal::Type::Enum
|
853
840
|
|