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/rbi/orb/models/plan.rbi
CHANGED
@@ -3,6 +3,8 @@
|
|
3
3
|
module Orb
|
4
4
|
module Models
|
5
5
|
class Plan < Orb::Internal::Type::BaseModel
|
6
|
+
OrHash = T.type_alias { T.any(Orb::Plan, Orb::Internal::AnyHash) }
|
7
|
+
|
6
8
|
sig { returns(String) }
|
7
9
|
attr_accessor :id
|
8
10
|
|
@@ -12,21 +14,21 @@ module Orb
|
|
12
14
|
returns(
|
13
15
|
T::Array[
|
14
16
|
T.any(
|
15
|
-
Orb::
|
16
|
-
Orb::
|
17
|
-
Orb::
|
18
|
-
Orb::
|
19
|
-
Orb::
|
17
|
+
Orb::Plan::Adjustment::UsageDiscount,
|
18
|
+
Orb::Plan::Adjustment::AmountDiscount,
|
19
|
+
Orb::Plan::Adjustment::PercentageDiscount,
|
20
|
+
Orb::Plan::Adjustment::Minimum,
|
21
|
+
Orb::Plan::Adjustment::Maximum
|
20
22
|
)
|
21
23
|
]
|
22
24
|
)
|
23
25
|
end
|
24
26
|
attr_accessor :adjustments
|
25
27
|
|
26
|
-
sig { returns(T.nilable(Orb::
|
28
|
+
sig { returns(T.nilable(Orb::Plan::BasePlan)) }
|
27
29
|
attr_reader :base_plan
|
28
30
|
|
29
|
-
sig { params(base_plan: T.nilable(
|
31
|
+
sig { params(base_plan: T.nilable(Orb::Plan::BasePlan::OrHash)).void }
|
30
32
|
attr_writer :base_plan
|
31
33
|
|
32
34
|
# The parent plan id if the given plan was created by overriding one or more of
|
@@ -54,10 +56,10 @@ module Orb
|
|
54
56
|
returns(
|
55
57
|
T.nilable(
|
56
58
|
T.any(
|
57
|
-
Orb::
|
58
|
-
Orb::
|
59
|
-
Orb::
|
60
|
-
Orb::
|
59
|
+
Orb::PercentageDiscount,
|
60
|
+
Orb::TrialDiscount,
|
61
|
+
Orb::UsageDiscount,
|
62
|
+
Orb::AmountDiscount
|
61
63
|
)
|
62
64
|
)
|
63
65
|
)
|
@@ -75,10 +77,10 @@ module Orb
|
|
75
77
|
sig { returns(String) }
|
76
78
|
attr_accessor :invoicing_currency
|
77
79
|
|
78
|
-
sig { returns(T.nilable(Orb::
|
80
|
+
sig { returns(T.nilable(Orb::Plan::Maximum)) }
|
79
81
|
attr_reader :maximum
|
80
82
|
|
81
|
-
sig { params(maximum: T.nilable(
|
83
|
+
sig { params(maximum: T.nilable(Orb::Plan::Maximum::OrHash)).void }
|
82
84
|
attr_writer :maximum
|
83
85
|
|
84
86
|
sig { returns(T.nilable(String)) }
|
@@ -91,10 +93,10 @@ module Orb
|
|
91
93
|
sig { returns(T::Hash[Symbol, String]) }
|
92
94
|
attr_accessor :metadata
|
93
95
|
|
94
|
-
sig { returns(T.nilable(Orb::
|
96
|
+
sig { returns(T.nilable(Orb::Plan::Minimum)) }
|
95
97
|
attr_reader :minimum
|
96
98
|
|
97
|
-
sig { params(minimum: T.nilable(
|
99
|
+
sig { params(minimum: T.nilable(Orb::Plan::Minimum::OrHash)).void }
|
98
100
|
attr_writer :minimum
|
99
101
|
|
100
102
|
sig { returns(T.nilable(String)) }
|
@@ -111,7 +113,7 @@ module Orb
|
|
111
113
|
sig { returns(T.nilable(Integer)) }
|
112
114
|
attr_accessor :net_terms
|
113
115
|
|
114
|
-
sig { returns(T.nilable(T::Array[Orb::
|
116
|
+
sig { returns(T.nilable(T::Array[Orb::Plan::PlanPhase])) }
|
115
117
|
attr_accessor :plan_phases
|
116
118
|
|
117
119
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
@@ -120,53 +122,53 @@ module Orb
|
|
120
122
|
returns(
|
121
123
|
T::Array[
|
122
124
|
T.any(
|
123
|
-
Orb::
|
124
|
-
Orb::
|
125
|
-
Orb::
|
126
|
-
Orb::
|
127
|
-
Orb::
|
128
|
-
Orb::
|
129
|
-
Orb::
|
130
|
-
Orb::
|
131
|
-
Orb::
|
132
|
-
Orb::
|
133
|
-
Orb::
|
134
|
-
Orb::
|
135
|
-
Orb::
|
136
|
-
Orb::
|
137
|
-
Orb::
|
138
|
-
Orb::
|
139
|
-
Orb::
|
140
|
-
Orb::
|
141
|
-
Orb::
|
142
|
-
Orb::
|
143
|
-
Orb::
|
144
|
-
Orb::
|
145
|
-
Orb::
|
146
|
-
Orb::
|
147
|
-
Orb::
|
148
|
-
Orb::
|
149
|
-
Orb::
|
150
|
-
Orb::
|
125
|
+
Orb::Price::Unit,
|
126
|
+
Orb::Price::Package,
|
127
|
+
Orb::Price::Matrix,
|
128
|
+
Orb::Price::Tiered,
|
129
|
+
Orb::Price::TieredBps,
|
130
|
+
Orb::Price::Bps,
|
131
|
+
Orb::Price::BulkBps,
|
132
|
+
Orb::Price::Bulk,
|
133
|
+
Orb::Price::ThresholdTotalAmount,
|
134
|
+
Orb::Price::TieredPackage,
|
135
|
+
Orb::Price::GroupedTiered,
|
136
|
+
Orb::Price::TieredWithMinimum,
|
137
|
+
Orb::Price::TieredPackageWithMinimum,
|
138
|
+
Orb::Price::PackageWithAllocation,
|
139
|
+
Orb::Price::UnitWithPercent,
|
140
|
+
Orb::Price::MatrixWithAllocation,
|
141
|
+
Orb::Price::TieredWithProration,
|
142
|
+
Orb::Price::UnitWithProration,
|
143
|
+
Orb::Price::GroupedAllocation,
|
144
|
+
Orb::Price::GroupedWithProratedMinimum,
|
145
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
146
|
+
Orb::Price::MatrixWithDisplayName,
|
147
|
+
Orb::Price::BulkWithProration,
|
148
|
+
Orb::Price::GroupedTieredPackage,
|
149
|
+
Orb::Price::MaxGroupTieredPackage,
|
150
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
151
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
152
|
+
Orb::Price::CumulativeGroupedBulk
|
151
153
|
)
|
152
154
|
]
|
153
155
|
)
|
154
156
|
end
|
155
157
|
attr_accessor :prices
|
156
158
|
|
157
|
-
sig { returns(Orb::
|
159
|
+
sig { returns(Orb::Plan::Product) }
|
158
160
|
attr_reader :product
|
159
161
|
|
160
|
-
sig { params(product:
|
162
|
+
sig { params(product: Orb::Plan::Product::OrHash).void }
|
161
163
|
attr_writer :product
|
162
164
|
|
163
|
-
sig { returns(Orb::
|
165
|
+
sig { returns(Orb::Plan::Status::TaggedSymbol) }
|
164
166
|
attr_accessor :status
|
165
167
|
|
166
|
-
sig { returns(Orb::
|
168
|
+
sig { returns(Orb::Plan::TrialConfig) }
|
167
169
|
attr_reader :trial_config
|
168
170
|
|
169
|
-
sig { params(trial_config:
|
171
|
+
sig { params(trial_config: Orb::Plan::TrialConfig::OrHash).void }
|
170
172
|
attr_writer :trial_config
|
171
173
|
|
172
174
|
sig { returns(Integer) }
|
@@ -179,80 +181,79 @@ module Orb
|
|
179
181
|
sig do
|
180
182
|
params(
|
181
183
|
id: String,
|
182
|
-
adjustments:
|
183
|
-
T
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
base_plan: T.nilable(
|
184
|
+
adjustments:
|
185
|
+
T::Array[
|
186
|
+
T.any(
|
187
|
+
Orb::Plan::Adjustment::UsageDiscount::OrHash,
|
188
|
+
Orb::Plan::Adjustment::AmountDiscount::OrHash,
|
189
|
+
Orb::Plan::Adjustment::PercentageDiscount::OrHash,
|
190
|
+
Orb::Plan::Adjustment::Minimum::OrHash,
|
191
|
+
Orb::Plan::Adjustment::Maximum::OrHash
|
192
|
+
)
|
193
|
+
],
|
194
|
+
base_plan: T.nilable(Orb::Plan::BasePlan::OrHash),
|
193
195
|
base_plan_id: T.nilable(String),
|
194
196
|
created_at: Time,
|
195
197
|
currency: String,
|
196
198
|
default_invoice_memo: T.nilable(String),
|
197
199
|
description: String,
|
198
|
-
discount:
|
199
|
-
T.
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
200
|
+
discount:
|
201
|
+
T.nilable(
|
202
|
+
T.any(
|
203
|
+
Orb::PercentageDiscount::OrHash,
|
204
|
+
Orb::TrialDiscount::OrHash,
|
205
|
+
Orb::UsageDiscount::OrHash,
|
206
|
+
Orb::AmountDiscount::OrHash
|
207
|
+
)
|
208
|
+
),
|
207
209
|
external_plan_id: T.nilable(String),
|
208
210
|
invoicing_currency: String,
|
209
|
-
maximum: T.nilable(
|
211
|
+
maximum: T.nilable(Orb::Plan::Maximum::OrHash),
|
210
212
|
maximum_amount: T.nilable(String),
|
211
213
|
metadata: T::Hash[Symbol, String],
|
212
|
-
minimum: T.nilable(
|
214
|
+
minimum: T.nilable(Orb::Plan::Minimum::OrHash),
|
213
215
|
minimum_amount: T.nilable(String),
|
214
216
|
name: String,
|
215
217
|
net_terms: T.nilable(Integer),
|
216
|
-
plan_phases: T.nilable(T::Array[
|
217
|
-
prices:
|
218
|
-
T
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
product:
|
251
|
-
status: Orb::
|
252
|
-
trial_config:
|
218
|
+
plan_phases: T.nilable(T::Array[Orb::Plan::PlanPhase::OrHash]),
|
219
|
+
prices:
|
220
|
+
T::Array[
|
221
|
+
T.any(
|
222
|
+
Orb::Price::Unit::OrHash,
|
223
|
+
Orb::Price::Package::OrHash,
|
224
|
+
Orb::Price::Matrix::OrHash,
|
225
|
+
Orb::Price::Tiered::OrHash,
|
226
|
+
Orb::Price::TieredBps::OrHash,
|
227
|
+
Orb::Price::Bps::OrHash,
|
228
|
+
Orb::Price::BulkBps::OrHash,
|
229
|
+
Orb::Price::Bulk::OrHash,
|
230
|
+
Orb::Price::ThresholdTotalAmount::OrHash,
|
231
|
+
Orb::Price::TieredPackage::OrHash,
|
232
|
+
Orb::Price::GroupedTiered::OrHash,
|
233
|
+
Orb::Price::TieredWithMinimum::OrHash,
|
234
|
+
Orb::Price::TieredPackageWithMinimum::OrHash,
|
235
|
+
Orb::Price::PackageWithAllocation::OrHash,
|
236
|
+
Orb::Price::UnitWithPercent::OrHash,
|
237
|
+
Orb::Price::MatrixWithAllocation::OrHash,
|
238
|
+
Orb::Price::TieredWithProration::OrHash,
|
239
|
+
Orb::Price::UnitWithProration::OrHash,
|
240
|
+
Orb::Price::GroupedAllocation::OrHash,
|
241
|
+
Orb::Price::GroupedWithProratedMinimum::OrHash,
|
242
|
+
Orb::Price::GroupedWithMeteredMinimum::OrHash,
|
243
|
+
Orb::Price::MatrixWithDisplayName::OrHash,
|
244
|
+
Orb::Price::BulkWithProration::OrHash,
|
245
|
+
Orb::Price::GroupedTieredPackage::OrHash,
|
246
|
+
Orb::Price::MaxGroupTieredPackage::OrHash,
|
247
|
+
Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
|
248
|
+
Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
|
249
|
+
Orb::Price::CumulativeGroupedBulk::OrHash
|
250
|
+
)
|
251
|
+
],
|
252
|
+
product: Orb::Plan::Product::OrHash,
|
253
|
+
status: Orb::Plan::Status::OrSymbol,
|
254
|
+
trial_config: Orb::Plan::TrialConfig::OrHash,
|
253
255
|
version: Integer
|
254
|
-
)
|
255
|
-
.returns(T.attached_class)
|
256
|
+
).returns(T.attached_class)
|
256
257
|
end
|
257
258
|
def self.new(
|
258
259
|
id:,
|
@@ -303,90 +304,114 @@ module Orb
|
|
303
304
|
status:,
|
304
305
|
trial_config:,
|
305
306
|
version:
|
306
|
-
)
|
307
|
+
)
|
308
|
+
end
|
309
|
+
|
307
310
|
sig do
|
308
|
-
override
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
311
|
+
override.returns(
|
312
|
+
{
|
313
|
+
id: String,
|
314
|
+
adjustments:
|
315
|
+
T::Array[
|
313
316
|
T.any(
|
314
|
-
Orb::
|
315
|
-
Orb::
|
316
|
-
Orb::
|
317
|
-
Orb::
|
318
|
-
Orb::
|
317
|
+
Orb::Plan::Adjustment::UsageDiscount,
|
318
|
+
Orb::Plan::Adjustment::AmountDiscount,
|
319
|
+
Orb::Plan::Adjustment::PercentageDiscount,
|
320
|
+
Orb::Plan::Adjustment::Minimum,
|
321
|
+
Orb::Plan::Adjustment::Maximum
|
319
322
|
)
|
320
323
|
],
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
324
|
+
base_plan: T.nilable(Orb::Plan::BasePlan),
|
325
|
+
base_plan_id: T.nilable(String),
|
326
|
+
created_at: Time,
|
327
|
+
currency: String,
|
328
|
+
default_invoice_memo: T.nilable(String),
|
329
|
+
description: String,
|
330
|
+
discount:
|
331
|
+
T.nilable(
|
328
332
|
T.any(
|
329
|
-
Orb::
|
330
|
-
Orb::
|
331
|
-
Orb::
|
332
|
-
Orb::
|
333
|
+
Orb::PercentageDiscount,
|
334
|
+
Orb::TrialDiscount,
|
335
|
+
Orb::UsageDiscount,
|
336
|
+
Orb::AmountDiscount
|
333
337
|
)
|
334
338
|
),
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
339
|
+
external_plan_id: T.nilable(String),
|
340
|
+
invoicing_currency: String,
|
341
|
+
maximum: T.nilable(Orb::Plan::Maximum),
|
342
|
+
maximum_amount: T.nilable(String),
|
343
|
+
metadata: T::Hash[Symbol, String],
|
344
|
+
minimum: T.nilable(Orb::Plan::Minimum),
|
345
|
+
minimum_amount: T.nilable(String),
|
346
|
+
name: String,
|
347
|
+
net_terms: T.nilable(Integer),
|
348
|
+
plan_phases: T.nilable(T::Array[Orb::Plan::PlanPhase]),
|
349
|
+
prices:
|
350
|
+
T::Array[
|
346
351
|
T.any(
|
347
|
-
Orb::
|
348
|
-
Orb::
|
349
|
-
Orb::
|
350
|
-
Orb::
|
351
|
-
Orb::
|
352
|
-
Orb::
|
353
|
-
Orb::
|
354
|
-
Orb::
|
355
|
-
Orb::
|
356
|
-
Orb::
|
357
|
-
Orb::
|
358
|
-
Orb::
|
359
|
-
Orb::
|
360
|
-
Orb::
|
361
|
-
Orb::
|
362
|
-
Orb::
|
363
|
-
Orb::
|
364
|
-
Orb::
|
365
|
-
Orb::
|
366
|
-
Orb::
|
367
|
-
Orb::
|
368
|
-
Orb::
|
369
|
-
Orb::
|
370
|
-
Orb::
|
371
|
-
Orb::
|
372
|
-
Orb::
|
373
|
-
Orb::
|
374
|
-
Orb::
|
352
|
+
Orb::Price::Unit,
|
353
|
+
Orb::Price::Package,
|
354
|
+
Orb::Price::Matrix,
|
355
|
+
Orb::Price::Tiered,
|
356
|
+
Orb::Price::TieredBps,
|
357
|
+
Orb::Price::Bps,
|
358
|
+
Orb::Price::BulkBps,
|
359
|
+
Orb::Price::Bulk,
|
360
|
+
Orb::Price::ThresholdTotalAmount,
|
361
|
+
Orb::Price::TieredPackage,
|
362
|
+
Orb::Price::GroupedTiered,
|
363
|
+
Orb::Price::TieredWithMinimum,
|
364
|
+
Orb::Price::TieredPackageWithMinimum,
|
365
|
+
Orb::Price::PackageWithAllocation,
|
366
|
+
Orb::Price::UnitWithPercent,
|
367
|
+
Orb::Price::MatrixWithAllocation,
|
368
|
+
Orb::Price::TieredWithProration,
|
369
|
+
Orb::Price::UnitWithProration,
|
370
|
+
Orb::Price::GroupedAllocation,
|
371
|
+
Orb::Price::GroupedWithProratedMinimum,
|
372
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
373
|
+
Orb::Price::MatrixWithDisplayName,
|
374
|
+
Orb::Price::BulkWithProration,
|
375
|
+
Orb::Price::GroupedTieredPackage,
|
376
|
+
Orb::Price::MaxGroupTieredPackage,
|
377
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
378
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
379
|
+
Orb::Price::CumulativeGroupedBulk
|
375
380
|
)
|
376
381
|
],
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
382
|
+
product: Orb::Plan::Product,
|
383
|
+
status: Orb::Plan::Status::TaggedSymbol,
|
384
|
+
trial_config: Orb::Plan::TrialConfig,
|
385
|
+
version: Integer
|
386
|
+
}
|
387
|
+
)
|
388
|
+
end
|
389
|
+
def to_hash
|
383
390
|
end
|
384
|
-
def to_hash; end
|
385
391
|
|
386
392
|
module Adjustment
|
387
393
|
extend Orb::Internal::Type::Union
|
388
394
|
|
395
|
+
Variants =
|
396
|
+
T.type_alias do
|
397
|
+
T.any(
|
398
|
+
Orb::Plan::Adjustment::UsageDiscount,
|
399
|
+
Orb::Plan::Adjustment::AmountDiscount,
|
400
|
+
Orb::Plan::Adjustment::PercentageDiscount,
|
401
|
+
Orb::Plan::Adjustment::Minimum,
|
402
|
+
Orb::Plan::Adjustment::Maximum
|
403
|
+
)
|
404
|
+
end
|
405
|
+
|
389
406
|
class UsageDiscount < Orb::Internal::Type::BaseModel
|
407
|
+
OrHash =
|
408
|
+
T.type_alias do
|
409
|
+
T.any(
|
410
|
+
Orb::Plan::Adjustment::UsageDiscount,
|
411
|
+
Orb::Internal::AnyHash
|
412
|
+
)
|
413
|
+
end
|
414
|
+
|
390
415
|
sig { returns(String) }
|
391
416
|
attr_accessor :id
|
392
417
|
|
@@ -424,8 +449,7 @@ module Orb
|
|
424
449
|
reason: T.nilable(String),
|
425
450
|
usage_discount: Float,
|
426
451
|
adjustment_type: Symbol
|
427
|
-
)
|
428
|
-
.returns(T.attached_class)
|
452
|
+
).returns(T.attached_class)
|
429
453
|
end
|
430
454
|
def self.new(
|
431
455
|
id:,
|
@@ -442,25 +466,35 @@ module Orb
|
|
442
466
|
# to in a given billing period.
|
443
467
|
usage_discount:,
|
444
468
|
adjustment_type: :usage_discount
|
445
|
-
)
|
469
|
+
)
|
470
|
+
end
|
471
|
+
|
446
472
|
sig do
|
447
|
-
override
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
473
|
+
override.returns(
|
474
|
+
{
|
475
|
+
id: String,
|
476
|
+
adjustment_type: Symbol,
|
477
|
+
applies_to_price_ids: T::Array[String],
|
478
|
+
is_invoice_level: T::Boolean,
|
479
|
+
plan_phase_order: T.nilable(Integer),
|
480
|
+
reason: T.nilable(String),
|
481
|
+
usage_discount: Float
|
482
|
+
}
|
483
|
+
)
|
484
|
+
end
|
485
|
+
def to_hash
|
459
486
|
end
|
460
|
-
def to_hash; end
|
461
487
|
end
|
462
488
|
|
463
489
|
class AmountDiscount < Orb::Internal::Type::BaseModel
|
490
|
+
OrHash =
|
491
|
+
T.type_alias do
|
492
|
+
T.any(
|
493
|
+
Orb::Plan::Adjustment::AmountDiscount,
|
494
|
+
Orb::Internal::AnyHash
|
495
|
+
)
|
496
|
+
end
|
497
|
+
|
464
498
|
sig { returns(String) }
|
465
499
|
attr_accessor :id
|
466
500
|
|
@@ -498,8 +532,7 @@ module Orb
|
|
498
532
|
plan_phase_order: T.nilable(Integer),
|
499
533
|
reason: T.nilable(String),
|
500
534
|
adjustment_type: Symbol
|
501
|
-
)
|
502
|
-
.returns(T.attached_class)
|
535
|
+
).returns(T.attached_class)
|
503
536
|
end
|
504
537
|
def self.new(
|
505
538
|
id:,
|
@@ -516,25 +549,35 @@ module Orb
|
|
516
549
|
# The reason for the adjustment.
|
517
550
|
reason:,
|
518
551
|
adjustment_type: :amount_discount
|
519
|
-
)
|
552
|
+
)
|
553
|
+
end
|
554
|
+
|
520
555
|
sig do
|
521
|
-
override
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
|
532
|
-
|
556
|
+
override.returns(
|
557
|
+
{
|
558
|
+
id: String,
|
559
|
+
adjustment_type: Symbol,
|
560
|
+
amount_discount: String,
|
561
|
+
applies_to_price_ids: T::Array[String],
|
562
|
+
is_invoice_level: T::Boolean,
|
563
|
+
plan_phase_order: T.nilable(Integer),
|
564
|
+
reason: T.nilable(String)
|
565
|
+
}
|
566
|
+
)
|
567
|
+
end
|
568
|
+
def to_hash
|
533
569
|
end
|
534
|
-
def to_hash; end
|
535
570
|
end
|
536
571
|
|
537
572
|
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
573
|
+
OrHash =
|
574
|
+
T.type_alias do
|
575
|
+
T.any(
|
576
|
+
Orb::Plan::Adjustment::PercentageDiscount,
|
577
|
+
Orb::Internal::AnyHash
|
578
|
+
)
|
579
|
+
end
|
580
|
+
|
538
581
|
sig { returns(String) }
|
539
582
|
attr_accessor :id
|
540
583
|
|
@@ -572,8 +615,7 @@ module Orb
|
|
572
615
|
plan_phase_order: T.nilable(Integer),
|
573
616
|
reason: T.nilable(String),
|
574
617
|
adjustment_type: Symbol
|
575
|
-
)
|
576
|
-
.returns(T.attached_class)
|
618
|
+
).returns(T.attached_class)
|
577
619
|
end
|
578
620
|
def self.new(
|
579
621
|
id:,
|
@@ -590,25 +632,32 @@ module Orb
|
|
590
632
|
# The reason for the adjustment.
|
591
633
|
reason:,
|
592
634
|
adjustment_type: :percentage_discount
|
593
|
-
)
|
635
|
+
)
|
636
|
+
end
|
637
|
+
|
594
638
|
sig do
|
595
|
-
override
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
603
|
-
|
604
|
-
|
605
|
-
|
606
|
-
|
639
|
+
override.returns(
|
640
|
+
{
|
641
|
+
id: String,
|
642
|
+
adjustment_type: Symbol,
|
643
|
+
applies_to_price_ids: T::Array[String],
|
644
|
+
is_invoice_level: T::Boolean,
|
645
|
+
percentage_discount: Float,
|
646
|
+
plan_phase_order: T.nilable(Integer),
|
647
|
+
reason: T.nilable(String)
|
648
|
+
}
|
649
|
+
)
|
650
|
+
end
|
651
|
+
def to_hash
|
607
652
|
end
|
608
|
-
def to_hash; end
|
609
653
|
end
|
610
654
|
|
611
655
|
class Minimum < Orb::Internal::Type::BaseModel
|
656
|
+
OrHash =
|
657
|
+
T.type_alias do
|
658
|
+
T.any(Orb::Plan::Adjustment::Minimum, Orb::Internal::AnyHash)
|
659
|
+
end
|
660
|
+
|
612
661
|
sig { returns(String) }
|
613
662
|
attr_accessor :id
|
614
663
|
|
@@ -651,8 +700,7 @@ module Orb
|
|
651
700
|
plan_phase_order: T.nilable(Integer),
|
652
701
|
reason: T.nilable(String),
|
653
702
|
adjustment_type: Symbol
|
654
|
-
)
|
655
|
-
.returns(T.attached_class)
|
703
|
+
).returns(T.attached_class)
|
656
704
|
end
|
657
705
|
def self.new(
|
658
706
|
id:,
|
@@ -671,26 +719,33 @@ module Orb
|
|
671
719
|
# The reason for the adjustment.
|
672
720
|
reason:,
|
673
721
|
adjustment_type: :minimum
|
674
|
-
)
|
722
|
+
)
|
723
|
+
end
|
724
|
+
|
675
725
|
sig do
|
676
|
-
override
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
685
|
-
|
686
|
-
|
687
|
-
|
688
|
-
|
726
|
+
override.returns(
|
727
|
+
{
|
728
|
+
id: String,
|
729
|
+
adjustment_type: Symbol,
|
730
|
+
applies_to_price_ids: T::Array[String],
|
731
|
+
is_invoice_level: T::Boolean,
|
732
|
+
item_id: String,
|
733
|
+
minimum_amount: String,
|
734
|
+
plan_phase_order: T.nilable(Integer),
|
735
|
+
reason: T.nilable(String)
|
736
|
+
}
|
737
|
+
)
|
738
|
+
end
|
739
|
+
def to_hash
|
689
740
|
end
|
690
|
-
def to_hash; end
|
691
741
|
end
|
692
742
|
|
693
743
|
class Maximum < Orb::Internal::Type::BaseModel
|
744
|
+
OrHash =
|
745
|
+
T.type_alias do
|
746
|
+
T.any(Orb::Plan::Adjustment::Maximum, Orb::Internal::AnyHash)
|
747
|
+
end
|
748
|
+
|
694
749
|
sig { returns(String) }
|
695
750
|
attr_accessor :id
|
696
751
|
|
@@ -728,8 +783,7 @@ module Orb
|
|
728
783
|
plan_phase_order: T.nilable(Integer),
|
729
784
|
reason: T.nilable(String),
|
730
785
|
adjustment_type: Symbol
|
731
|
-
)
|
732
|
-
.returns(T.attached_class)
|
786
|
+
).returns(T.attached_class)
|
733
787
|
end
|
734
788
|
def self.new(
|
735
789
|
id:,
|
@@ -746,34 +800,35 @@ module Orb
|
|
746
800
|
# The reason for the adjustment.
|
747
801
|
reason:,
|
748
802
|
adjustment_type: :maximum
|
749
|
-
)
|
803
|
+
)
|
804
|
+
end
|
805
|
+
|
750
806
|
sig do
|
751
|
-
override
|
752
|
-
|
753
|
-
|
754
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
|
760
|
-
|
761
|
-
|
762
|
-
|
807
|
+
override.returns(
|
808
|
+
{
|
809
|
+
id: String,
|
810
|
+
adjustment_type: Symbol,
|
811
|
+
applies_to_price_ids: T::Array[String],
|
812
|
+
is_invoice_level: T::Boolean,
|
813
|
+
maximum_amount: String,
|
814
|
+
plan_phase_order: T.nilable(Integer),
|
815
|
+
reason: T.nilable(String)
|
816
|
+
}
|
817
|
+
)
|
818
|
+
end
|
819
|
+
def to_hash
|
763
820
|
end
|
764
|
-
def to_hash; end
|
765
821
|
end
|
766
822
|
|
767
|
-
sig
|
768
|
-
|
769
|
-
.returns(
|
770
|
-
[Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum]
|
771
|
-
)
|
823
|
+
sig { override.returns(T::Array[Orb::Plan::Adjustment::Variants]) }
|
824
|
+
def self.variants
|
772
825
|
end
|
773
|
-
def self.variants; end
|
774
826
|
end
|
775
827
|
|
776
828
|
class BasePlan < Orb::Internal::Type::BaseModel
|
829
|
+
OrHash =
|
830
|
+
T.type_alias { T.any(Orb::Plan::BasePlan, Orb::Internal::AnyHash) }
|
831
|
+
|
777
832
|
sig { returns(T.nilable(String)) }
|
778
833
|
attr_accessor :id
|
779
834
|
|
@@ -787,8 +842,11 @@ module Orb
|
|
787
842
|
attr_accessor :name
|
788
843
|
|
789
844
|
sig do
|
790
|
-
params(
|
791
|
-
.
|
845
|
+
params(
|
846
|
+
id: T.nilable(String),
|
847
|
+
external_plan_id: T.nilable(String),
|
848
|
+
name: T.nilable(String)
|
849
|
+
).returns(T.attached_class)
|
792
850
|
end
|
793
851
|
def self.new(
|
794
852
|
id:,
|
@@ -797,7 +855,9 @@ module Orb
|
|
797
855
|
# identifier in your system.
|
798
856
|
external_plan_id:,
|
799
857
|
name:
|
800
|
-
)
|
858
|
+
)
|
859
|
+
end
|
860
|
+
|
801
861
|
sig do
|
802
862
|
override.returns(
|
803
863
|
{
|
@@ -807,10 +867,14 @@ module Orb
|
|
807
867
|
}
|
808
868
|
)
|
809
869
|
end
|
810
|
-
def to_hash
|
870
|
+
def to_hash
|
871
|
+
end
|
811
872
|
end
|
812
873
|
|
813
874
|
class Maximum < Orb::Internal::Type::BaseModel
|
875
|
+
OrHash =
|
876
|
+
T.type_alias { T.any(Orb::Plan::Maximum, Orb::Internal::AnyHash) }
|
877
|
+
|
814
878
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
815
879
|
# maximums, this can be a subset of prices.
|
816
880
|
sig { returns(T::Array[String]) }
|
@@ -821,7 +885,10 @@ module Orb
|
|
821
885
|
attr_accessor :maximum_amount
|
822
886
|
|
823
887
|
sig do
|
824
|
-
params(
|
888
|
+
params(
|
889
|
+
applies_to_price_ids: T::Array[String],
|
890
|
+
maximum_amount: String
|
891
|
+
).returns(T.attached_class)
|
825
892
|
end
|
826
893
|
def self.new(
|
827
894
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -829,12 +896,22 @@ module Orb
|
|
829
896
|
applies_to_price_ids:,
|
830
897
|
# Maximum amount applied
|
831
898
|
maximum_amount:
|
832
|
-
)
|
833
|
-
|
834
|
-
|
899
|
+
)
|
900
|
+
end
|
901
|
+
|
902
|
+
sig do
|
903
|
+
override.returns(
|
904
|
+
{ applies_to_price_ids: T::Array[String], maximum_amount: String }
|
905
|
+
)
|
906
|
+
end
|
907
|
+
def to_hash
|
908
|
+
end
|
835
909
|
end
|
836
910
|
|
837
911
|
class Minimum < Orb::Internal::Type::BaseModel
|
912
|
+
OrHash =
|
913
|
+
T.type_alias { T.any(Orb::Plan::Minimum, Orb::Internal::AnyHash) }
|
914
|
+
|
838
915
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
839
916
|
# minimums, this can be a subset of prices.
|
840
917
|
sig { returns(T::Array[String]) }
|
@@ -845,7 +922,10 @@ module Orb
|
|
845
922
|
attr_accessor :minimum_amount
|
846
923
|
|
847
924
|
sig do
|
848
|
-
params(
|
925
|
+
params(
|
926
|
+
applies_to_price_ids: T::Array[String],
|
927
|
+
minimum_amount: String
|
928
|
+
).returns(T.attached_class)
|
849
929
|
end
|
850
930
|
def self.new(
|
851
931
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -853,12 +933,22 @@ module Orb
|
|
853
933
|
applies_to_price_ids:,
|
854
934
|
# Minimum amount applied
|
855
935
|
minimum_amount:
|
856
|
-
)
|
857
|
-
|
858
|
-
|
936
|
+
)
|
937
|
+
end
|
938
|
+
|
939
|
+
sig do
|
940
|
+
override.returns(
|
941
|
+
{ applies_to_price_ids: T::Array[String], minimum_amount: String }
|
942
|
+
)
|
943
|
+
end
|
944
|
+
def to_hash
|
945
|
+
end
|
859
946
|
end
|
860
947
|
|
861
948
|
class PlanPhase < Orb::Internal::Type::BaseModel
|
949
|
+
OrHash =
|
950
|
+
T.type_alias { T.any(Orb::Plan::PlanPhase, Orb::Internal::AnyHash) }
|
951
|
+
|
862
952
|
sig { returns(String) }
|
863
953
|
attr_accessor :id
|
864
954
|
|
@@ -869,10 +959,10 @@ module Orb
|
|
869
959
|
returns(
|
870
960
|
T.nilable(
|
871
961
|
T.any(
|
872
|
-
Orb::
|
873
|
-
Orb::
|
874
|
-
Orb::
|
875
|
-
Orb::
|
962
|
+
Orb::PercentageDiscount,
|
963
|
+
Orb::TrialDiscount,
|
964
|
+
Orb::UsageDiscount,
|
965
|
+
Orb::AmountDiscount
|
876
966
|
)
|
877
967
|
)
|
878
968
|
)
|
@@ -884,22 +974,28 @@ module Orb
|
|
884
974
|
sig { returns(T.nilable(Integer)) }
|
885
975
|
attr_accessor :duration
|
886
976
|
|
887
|
-
sig
|
977
|
+
sig do
|
978
|
+
returns(T.nilable(Orb::Plan::PlanPhase::DurationUnit::TaggedSymbol))
|
979
|
+
end
|
888
980
|
attr_accessor :duration_unit
|
889
981
|
|
890
|
-
sig { returns(T.nilable(Orb::
|
982
|
+
sig { returns(T.nilable(Orb::Plan::PlanPhase::Maximum)) }
|
891
983
|
attr_reader :maximum
|
892
984
|
|
893
|
-
sig
|
985
|
+
sig do
|
986
|
+
params(maximum: T.nilable(Orb::Plan::PlanPhase::Maximum::OrHash)).void
|
987
|
+
end
|
894
988
|
attr_writer :maximum
|
895
989
|
|
896
990
|
sig { returns(T.nilable(String)) }
|
897
991
|
attr_accessor :maximum_amount
|
898
992
|
|
899
|
-
sig { returns(T.nilable(Orb::
|
993
|
+
sig { returns(T.nilable(Orb::Plan::PlanPhase::Minimum)) }
|
900
994
|
attr_reader :minimum
|
901
995
|
|
902
|
-
sig
|
996
|
+
sig do
|
997
|
+
params(minimum: T.nilable(Orb::Plan::PlanPhase::Minimum::OrHash)).void
|
998
|
+
end
|
903
999
|
attr_writer :minimum
|
904
1000
|
|
905
1001
|
sig { returns(T.nilable(String)) }
|
@@ -916,25 +1012,25 @@ module Orb
|
|
916
1012
|
params(
|
917
1013
|
id: String,
|
918
1014
|
description: T.nilable(String),
|
919
|
-
discount:
|
920
|
-
T.
|
921
|
-
|
922
|
-
|
923
|
-
|
924
|
-
|
925
|
-
|
926
|
-
|
927
|
-
|
1015
|
+
discount:
|
1016
|
+
T.nilable(
|
1017
|
+
T.any(
|
1018
|
+
Orb::PercentageDiscount::OrHash,
|
1019
|
+
Orb::TrialDiscount::OrHash,
|
1020
|
+
Orb::UsageDiscount::OrHash,
|
1021
|
+
Orb::AmountDiscount::OrHash
|
1022
|
+
)
|
1023
|
+
),
|
928
1024
|
duration: T.nilable(Integer),
|
929
|
-
duration_unit:
|
930
|
-
|
1025
|
+
duration_unit:
|
1026
|
+
T.nilable(Orb::Plan::PlanPhase::DurationUnit::OrSymbol),
|
1027
|
+
maximum: T.nilable(Orb::Plan::PlanPhase::Maximum::OrHash),
|
931
1028
|
maximum_amount: T.nilable(String),
|
932
|
-
minimum: T.nilable(
|
1029
|
+
minimum: T.nilable(Orb::Plan::PlanPhase::Minimum::OrHash),
|
933
1030
|
minimum_amount: T.nilable(String),
|
934
1031
|
name: String,
|
935
1032
|
order: Integer
|
936
|
-
)
|
937
|
-
.returns(T.attached_class)
|
1033
|
+
).returns(T.attached_class)
|
938
1034
|
end
|
939
1035
|
def self.new(
|
940
1036
|
id:,
|
@@ -951,51 +1047,74 @@ module Orb
|
|
951
1047
|
name:,
|
952
1048
|
# Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
|
953
1049
|
order:
|
954
|
-
)
|
1050
|
+
)
|
1051
|
+
end
|
1052
|
+
|
955
1053
|
sig do
|
956
|
-
override
|
957
|
-
|
958
|
-
|
959
|
-
|
960
|
-
|
961
|
-
|
1054
|
+
override.returns(
|
1055
|
+
{
|
1056
|
+
id: String,
|
1057
|
+
description: T.nilable(String),
|
1058
|
+
discount:
|
1059
|
+
T.nilable(
|
962
1060
|
T.any(
|
963
|
-
Orb::
|
964
|
-
Orb::
|
965
|
-
Orb::
|
966
|
-
Orb::
|
1061
|
+
Orb::PercentageDiscount,
|
1062
|
+
Orb::TrialDiscount,
|
1063
|
+
Orb::UsageDiscount,
|
1064
|
+
Orb::AmountDiscount
|
967
1065
|
)
|
968
1066
|
),
|
969
|
-
|
970
|
-
|
971
|
-
|
972
|
-
|
973
|
-
|
974
|
-
|
975
|
-
|
976
|
-
|
977
|
-
|
978
|
-
|
1067
|
+
duration: T.nilable(Integer),
|
1068
|
+
duration_unit:
|
1069
|
+
T.nilable(Orb::Plan::PlanPhase::DurationUnit::TaggedSymbol),
|
1070
|
+
maximum: T.nilable(Orb::Plan::PlanPhase::Maximum),
|
1071
|
+
maximum_amount: T.nilable(String),
|
1072
|
+
minimum: T.nilable(Orb::Plan::PlanPhase::Minimum),
|
1073
|
+
minimum_amount: T.nilable(String),
|
1074
|
+
name: String,
|
1075
|
+
order: Integer
|
1076
|
+
}
|
1077
|
+
)
|
1078
|
+
end
|
1079
|
+
def to_hash
|
979
1080
|
end
|
980
|
-
def to_hash; end
|
981
1081
|
|
982
1082
|
module DurationUnit
|
983
1083
|
extend Orb::Internal::Type::Enum
|
984
1084
|
|
985
|
-
TaggedSymbol =
|
1085
|
+
TaggedSymbol =
|
1086
|
+
T.type_alias { T.all(Symbol, Orb::Plan::PlanPhase::DurationUnit) }
|
986
1087
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
987
1088
|
|
988
|
-
DAILY =
|
989
|
-
|
990
|
-
|
991
|
-
|
992
|
-
|
1089
|
+
DAILY =
|
1090
|
+
T.let(:daily, Orb::Plan::PlanPhase::DurationUnit::TaggedSymbol)
|
1091
|
+
MONTHLY =
|
1092
|
+
T.let(:monthly, Orb::Plan::PlanPhase::DurationUnit::TaggedSymbol)
|
1093
|
+
QUARTERLY =
|
1094
|
+
T.let(:quarterly, Orb::Plan::PlanPhase::DurationUnit::TaggedSymbol)
|
1095
|
+
SEMI_ANNUAL =
|
1096
|
+
T.let(
|
1097
|
+
:semi_annual,
|
1098
|
+
Orb::Plan::PlanPhase::DurationUnit::TaggedSymbol
|
1099
|
+
)
|
1100
|
+
ANNUAL =
|
1101
|
+
T.let(:annual, Orb::Plan::PlanPhase::DurationUnit::TaggedSymbol)
|
993
1102
|
|
994
|
-
sig
|
995
|
-
|
1103
|
+
sig do
|
1104
|
+
override.returns(
|
1105
|
+
T::Array[Orb::Plan::PlanPhase::DurationUnit::TaggedSymbol]
|
1106
|
+
)
|
1107
|
+
end
|
1108
|
+
def self.values
|
1109
|
+
end
|
996
1110
|
end
|
997
1111
|
|
998
1112
|
class Maximum < Orb::Internal::Type::BaseModel
|
1113
|
+
OrHash =
|
1114
|
+
T.type_alias do
|
1115
|
+
T.any(Orb::Plan::PlanPhase::Maximum, Orb::Internal::AnyHash)
|
1116
|
+
end
|
1117
|
+
|
999
1118
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
1000
1119
|
# maximums, this can be a subset of prices.
|
1001
1120
|
sig { returns(T::Array[String]) }
|
@@ -1006,7 +1125,10 @@ module Orb
|
|
1006
1125
|
attr_accessor :maximum_amount
|
1007
1126
|
|
1008
1127
|
sig do
|
1009
|
-
params(
|
1128
|
+
params(
|
1129
|
+
applies_to_price_ids: T::Array[String],
|
1130
|
+
maximum_amount: String
|
1131
|
+
).returns(T.attached_class)
|
1010
1132
|
end
|
1011
1133
|
def self.new(
|
1012
1134
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -1014,12 +1136,24 @@ module Orb
|
|
1014
1136
|
applies_to_price_ids:,
|
1015
1137
|
# Maximum amount applied
|
1016
1138
|
maximum_amount:
|
1017
|
-
)
|
1018
|
-
|
1019
|
-
|
1139
|
+
)
|
1140
|
+
end
|
1141
|
+
|
1142
|
+
sig do
|
1143
|
+
override.returns(
|
1144
|
+
{ applies_to_price_ids: T::Array[String], maximum_amount: String }
|
1145
|
+
)
|
1146
|
+
end
|
1147
|
+
def to_hash
|
1148
|
+
end
|
1020
1149
|
end
|
1021
1150
|
|
1022
1151
|
class Minimum < Orb::Internal::Type::BaseModel
|
1152
|
+
OrHash =
|
1153
|
+
T.type_alias do
|
1154
|
+
T.any(Orb::Plan::PlanPhase::Minimum, Orb::Internal::AnyHash)
|
1155
|
+
end
|
1156
|
+
|
1023
1157
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
1024
1158
|
# minimums, this can be a subset of prices.
|
1025
1159
|
sig { returns(T::Array[String]) }
|
@@ -1030,7 +1164,10 @@ module Orb
|
|
1030
1164
|
attr_accessor :minimum_amount
|
1031
1165
|
|
1032
1166
|
sig do
|
1033
|
-
params(
|
1167
|
+
params(
|
1168
|
+
applies_to_price_ids: T::Array[String],
|
1169
|
+
minimum_amount: String
|
1170
|
+
).returns(T.attached_class)
|
1034
1171
|
end
|
1035
1172
|
def self.new(
|
1036
1173
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -1038,13 +1175,23 @@ module Orb
|
|
1038
1175
|
applies_to_price_ids:,
|
1039
1176
|
# Minimum amount applied
|
1040
1177
|
minimum_amount:
|
1041
|
-
)
|
1042
|
-
|
1043
|
-
|
1178
|
+
)
|
1179
|
+
end
|
1180
|
+
|
1181
|
+
sig do
|
1182
|
+
override.returns(
|
1183
|
+
{ applies_to_price_ids: T::Array[String], minimum_amount: String }
|
1184
|
+
)
|
1185
|
+
end
|
1186
|
+
def to_hash
|
1187
|
+
end
|
1044
1188
|
end
|
1045
1189
|
end
|
1046
1190
|
|
1047
1191
|
class Product < Orb::Internal::Type::BaseModel
|
1192
|
+
OrHash =
|
1193
|
+
T.type_alias { T.any(Orb::Plan::Product, Orb::Internal::AnyHash) }
|
1194
|
+
|
1048
1195
|
sig { returns(String) }
|
1049
1196
|
attr_accessor :id
|
1050
1197
|
|
@@ -1054,64 +1201,84 @@ module Orb
|
|
1054
1201
|
sig { returns(String) }
|
1055
1202
|
attr_accessor :name
|
1056
1203
|
|
1057
|
-
sig
|
1058
|
-
|
1204
|
+
sig do
|
1205
|
+
params(id: String, created_at: Time, name: String).returns(
|
1206
|
+
T.attached_class
|
1207
|
+
)
|
1208
|
+
end
|
1209
|
+
def self.new(id:, created_at:, name:)
|
1210
|
+
end
|
1059
1211
|
|
1060
|
-
sig { override.returns({id: String, created_at: Time, name: String}) }
|
1061
|
-
def to_hash
|
1212
|
+
sig { override.returns({ id: String, created_at: Time, name: String }) }
|
1213
|
+
def to_hash
|
1214
|
+
end
|
1062
1215
|
end
|
1063
1216
|
|
1064
1217
|
module Status
|
1065
1218
|
extend Orb::Internal::Type::Enum
|
1066
1219
|
|
1067
|
-
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::
|
1220
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Plan::Status) }
|
1068
1221
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1069
1222
|
|
1070
|
-
ACTIVE = T.let(:active, Orb::
|
1071
|
-
ARCHIVED = T.let(:archived, Orb::
|
1072
|
-
DRAFT = T.let(:draft, Orb::
|
1223
|
+
ACTIVE = T.let(:active, Orb::Plan::Status::TaggedSymbol)
|
1224
|
+
ARCHIVED = T.let(:archived, Orb::Plan::Status::TaggedSymbol)
|
1225
|
+
DRAFT = T.let(:draft, Orb::Plan::Status::TaggedSymbol)
|
1073
1226
|
|
1074
|
-
sig { override.returns(T::Array[Orb::
|
1075
|
-
def self.values
|
1227
|
+
sig { override.returns(T::Array[Orb::Plan::Status::TaggedSymbol]) }
|
1228
|
+
def self.values
|
1229
|
+
end
|
1076
1230
|
end
|
1077
1231
|
|
1078
1232
|
class TrialConfig < Orb::Internal::Type::BaseModel
|
1233
|
+
OrHash =
|
1234
|
+
T.type_alias { T.any(Orb::Plan::TrialConfig, Orb::Internal::AnyHash) }
|
1235
|
+
|
1079
1236
|
sig { returns(T.nilable(Integer)) }
|
1080
1237
|
attr_accessor :trial_period
|
1081
1238
|
|
1082
|
-
sig { returns(Orb::
|
1239
|
+
sig { returns(Orb::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol) }
|
1083
1240
|
attr_accessor :trial_period_unit
|
1084
1241
|
|
1085
1242
|
sig do
|
1086
1243
|
params(
|
1087
1244
|
trial_period: T.nilable(Integer),
|
1088
|
-
trial_period_unit: Orb::
|
1089
|
-
)
|
1090
|
-
|
1245
|
+
trial_period_unit: Orb::Plan::TrialConfig::TrialPeriodUnit::OrSymbol
|
1246
|
+
).returns(T.attached_class)
|
1247
|
+
end
|
1248
|
+
def self.new(trial_period:, trial_period_unit:)
|
1091
1249
|
end
|
1092
|
-
def self.new(trial_period:, trial_period_unit:); end
|
1093
1250
|
|
1094
1251
|
sig do
|
1095
|
-
override
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1252
|
+
override.returns(
|
1253
|
+
{
|
1254
|
+
trial_period: T.nilable(Integer),
|
1255
|
+
trial_period_unit:
|
1256
|
+
Orb::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol
|
1257
|
+
}
|
1258
|
+
)
|
1259
|
+
end
|
1260
|
+
def to_hash
|
1102
1261
|
end
|
1103
|
-
def to_hash; end
|
1104
1262
|
|
1105
1263
|
module TrialPeriodUnit
|
1106
1264
|
extend Orb::Internal::Type::Enum
|
1107
1265
|
|
1108
|
-
TaggedSymbol =
|
1266
|
+
TaggedSymbol =
|
1267
|
+
T.type_alias do
|
1268
|
+
T.all(Symbol, Orb::Plan::TrialConfig::TrialPeriodUnit)
|
1269
|
+
end
|
1109
1270
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1110
1271
|
|
1111
|
-
DAYS =
|
1272
|
+
DAYS =
|
1273
|
+
T.let(:days, Orb::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol)
|
1112
1274
|
|
1113
|
-
sig
|
1114
|
-
|
1275
|
+
sig do
|
1276
|
+
override.returns(
|
1277
|
+
T::Array[Orb::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol]
|
1278
|
+
)
|
1279
|
+
end
|
1280
|
+
def self.values
|
1281
|
+
end
|
1115
1282
|
end
|
1116
1283
|
end
|
1117
1284
|
end
|