orb-billing 0.2.0 → 0.3.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 +34 -0
- data/README.md +59 -49
- data/lib/orb/client.rb +4 -4
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +4 -8
- data/lib/orb/internal/transport/base_client.rb +7 -7
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +11 -0
- data/lib/orb/internal/type/base_model.rb +32 -14
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +4 -0
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +9 -5
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
- data/lib/orb/internal/type/hash_of.rb +11 -0
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +4 -0
- data/lib/orb/internal/util.rb +69 -61
- data/lib/orb/internal.rb +0 -1
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +24 -29
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +211 -252
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +589 -637
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +2709 -3820
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +341 -377
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +108 -28
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +135 -36
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/lib/orb/client.rbi +4 -4
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +17 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/base_model.rbi +7 -1
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/enum.rbi +3 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +5 -2
- data/rbi/lib/orb/internal/type/hash_of.rbi +3 -0
- data/rbi/lib/orb/internal/type/union.rbi +3 -0
- data/rbi/lib/orb/internal/util.rbi +24 -19
- data/rbi/lib/orb/internal.rbi +0 -1
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +2 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +2 -0
- data/sig/orb/internal/type/union.rbs +2 -0
- data/sig/orb/internal/util.rbs +14 -12
- metadata +8 -5
data/lib/orb/models/plan.rb
CHANGED
@@ -34,6 +34,8 @@ module Orb
|
|
34
34
|
required :created_at, Time
|
35
35
|
|
36
36
|
# @!attribute currency
|
37
|
+
# @deprecated
|
38
|
+
#
|
37
39
|
# An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
|
38
40
|
# prices.
|
39
41
|
#
|
@@ -148,68 +150,71 @@ module Orb
|
|
148
150
|
# @return [Integer]
|
149
151
|
required :version, Integer
|
150
152
|
|
151
|
-
# @!
|
152
|
-
#
|
153
|
-
#
|
154
|
-
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
172
|
-
#
|
173
|
-
#
|
174
|
-
#
|
175
|
-
#
|
176
|
-
#
|
177
|
-
#
|
178
|
-
#
|
179
|
-
#
|
180
|
-
#
|
181
|
-
#
|
182
|
-
#
|
183
|
-
#
|
184
|
-
#
|
185
|
-
#
|
186
|
-
#
|
187
|
-
#
|
188
|
-
#
|
189
|
-
#
|
190
|
-
#
|
191
|
-
#
|
192
|
-
#
|
193
|
-
#
|
194
|
-
#
|
195
|
-
#
|
196
|
-
#
|
197
|
-
#
|
198
|
-
#
|
199
|
-
#
|
200
|
-
#
|
201
|
-
#
|
202
|
-
#
|
203
|
-
#
|
204
|
-
#
|
205
|
-
#
|
206
|
-
#
|
207
|
-
#
|
208
|
-
#
|
209
|
-
#
|
210
|
-
#
|
211
|
-
|
212
|
-
#
|
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::Models::Plan} for
|
155
|
+
# more details.
|
156
|
+
#
|
157
|
+
# The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
|
158
|
+
# subscribed to by a customer. Plans define the billing behavior of the
|
159
|
+
# subscription. You can see more about how to configure prices in the
|
160
|
+
# [Price resource](/reference/price).
|
161
|
+
#
|
162
|
+
# @param id [String]
|
163
|
+
#
|
164
|
+
# @param adjustments [Array<Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
|
165
|
+
# ...
|
166
|
+
#
|
167
|
+
# @param base_plan [Orb::Models::Plan::BasePlan, nil]
|
168
|
+
#
|
169
|
+
# @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
|
+
#
|
172
|
+
# @param created_at [Time]
|
173
|
+
#
|
174
|
+
# @param currency [String] An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's p
|
175
|
+
# ...
|
176
|
+
#
|
177
|
+
# @param default_invoice_memo [String, nil] The default memo text on the invoices corresponding to subscriptions on this pla
|
178
|
+
# ...
|
179
|
+
#
|
180
|
+
# @param description [String]
|
181
|
+
#
|
182
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
183
|
+
#
|
184
|
+
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
185
|
+
# ...
|
186
|
+
#
|
187
|
+
# @param invoicing_currency [String] An ISO 4217 currency string for which this plan is billed in. Matches `currency`
|
188
|
+
# ...
|
189
|
+
#
|
190
|
+
# @param maximum [Orb::Models::Plan::Maximum, nil]
|
191
|
+
#
|
192
|
+
# @param maximum_amount [String, nil]
|
193
|
+
#
|
194
|
+
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
195
|
+
# ...
|
196
|
+
#
|
197
|
+
# @param minimum [Orb::Models::Plan::Minimum, nil]
|
198
|
+
#
|
199
|
+
# @param minimum_amount [String, nil]
|
200
|
+
#
|
201
|
+
# @param name [String]
|
202
|
+
#
|
203
|
+
# @param net_terms [Integer, nil] Determines the difference between the invoice issue date and the due date. A val
|
204
|
+
# ...
|
205
|
+
#
|
206
|
+
# @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
|
207
|
+
#
|
208
|
+
# @param prices [Array<Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
209
|
+
# ...
|
210
|
+
#
|
211
|
+
# @param product [Orb::Models::Plan::Product]
|
212
|
+
#
|
213
|
+
# @param status [Symbol, Orb::Models::Plan::Status]
|
214
|
+
#
|
215
|
+
# @param trial_config [Orb::Models::Plan::TrialConfig]
|
216
|
+
#
|
217
|
+
# @param version [Integer]
|
213
218
|
|
214
219
|
module Adjustment
|
215
220
|
extend Orb::Internal::Type::Union
|
@@ -269,29 +274,26 @@ module Orb
|
|
269
274
|
# @return [Float]
|
270
275
|
required :usage_discount, Float
|
271
276
|
|
272
|
-
# @!
|
273
|
-
#
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
288
|
-
#
|
289
|
-
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
# end
|
293
|
-
|
294
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
277
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
278
|
+
# Some parameter documentations has been truncated, see
|
279
|
+
# {Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment} for more
|
280
|
+
# details.
|
281
|
+
#
|
282
|
+
# @param id [String]
|
283
|
+
#
|
284
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
285
|
+
#
|
286
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
287
|
+
# ...
|
288
|
+
#
|
289
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
290
|
+
#
|
291
|
+
# @param reason [String, nil] The reason for the adjustment.
|
292
|
+
#
|
293
|
+
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
294
|
+
# ...
|
295
|
+
#
|
296
|
+
# @param adjustment_type [Symbol, :usage_discount]
|
295
297
|
end
|
296
298
|
|
297
299
|
class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -337,29 +339,26 @@ module Orb
|
|
337
339
|
# @return [String, nil]
|
338
340
|
required :reason, String, nil?: true
|
339
341
|
|
340
|
-
# @!
|
341
|
-
#
|
342
|
-
#
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
346
|
-
#
|
347
|
-
#
|
348
|
-
#
|
349
|
-
#
|
350
|
-
#
|
351
|
-
#
|
352
|
-
#
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
#
|
358
|
-
#
|
359
|
-
#
|
360
|
-
# end
|
361
|
-
|
362
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
342
|
+
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
343
|
+
# Some parameter documentations has been truncated, see
|
344
|
+
# {Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment} for more
|
345
|
+
# details.
|
346
|
+
#
|
347
|
+
# @param id [String]
|
348
|
+
#
|
349
|
+
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
350
|
+
# ...
|
351
|
+
#
|
352
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
353
|
+
#
|
354
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
355
|
+
# ...
|
356
|
+
#
|
357
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
358
|
+
#
|
359
|
+
# @param reason [String, nil] The reason for the adjustment.
|
360
|
+
#
|
361
|
+
# @param adjustment_type [Symbol, :amount_discount]
|
363
362
|
end
|
364
363
|
|
365
364
|
class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
|
@@ -405,29 +404,26 @@ module Orb
|
|
405
404
|
# @return [String, nil]
|
406
405
|
required :reason, String, nil?: true
|
407
406
|
|
408
|
-
# @!
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
#
|
413
|
-
#
|
414
|
-
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
420
|
-
#
|
421
|
-
#
|
422
|
-
#
|
423
|
-
#
|
424
|
-
#
|
425
|
-
#
|
426
|
-
#
|
427
|
-
#
|
428
|
-
# end
|
429
|
-
|
430
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
407
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
408
|
+
# Some parameter documentations has been truncated, see
|
409
|
+
# {Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment} for more
|
410
|
+
# details.
|
411
|
+
#
|
412
|
+
# @param id [String]
|
413
|
+
#
|
414
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
415
|
+
#
|
416
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
417
|
+
# ...
|
418
|
+
#
|
419
|
+
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
420
|
+
# ...
|
421
|
+
#
|
422
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
423
|
+
#
|
424
|
+
# @param reason [String, nil] The reason for the adjustment.
|
425
|
+
#
|
426
|
+
# @param adjustment_type [Symbol, :percentage_discount]
|
431
427
|
end
|
432
428
|
|
433
429
|
class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -479,31 +475,27 @@ module Orb
|
|
479
475
|
# @return [String, nil]
|
480
476
|
required :reason, String, nil?: true
|
481
477
|
|
482
|
-
# @!
|
483
|
-
#
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
# super
|
504
|
-
# end
|
505
|
-
|
506
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
478
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
479
|
+
# Some parameter documentations has been truncated, see
|
480
|
+
# {Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment} for more details.
|
481
|
+
#
|
482
|
+
# @param id [String]
|
483
|
+
#
|
484
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
485
|
+
#
|
486
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
487
|
+
# ...
|
488
|
+
#
|
489
|
+
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
490
|
+
#
|
491
|
+
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
492
|
+
# ...
|
493
|
+
#
|
494
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
495
|
+
#
|
496
|
+
# @param reason [String, nil] The reason for the adjustment.
|
497
|
+
#
|
498
|
+
# @param adjustment_type [Symbol, :minimum]
|
507
499
|
end
|
508
500
|
|
509
501
|
class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
|
@@ -549,34 +541,29 @@ module Orb
|
|
549
541
|
# @return [String, nil]
|
550
542
|
required :reason, String, nil?: true
|
551
543
|
|
552
|
-
# @!
|
553
|
-
#
|
554
|
-
#
|
555
|
-
#
|
556
|
-
#
|
557
|
-
#
|
558
|
-
#
|
559
|
-
#
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
563
|
-
#
|
564
|
-
#
|
565
|
-
#
|
566
|
-
#
|
567
|
-
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
#
|
571
|
-
# super
|
572
|
-
# end
|
573
|
-
|
574
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
544
|
+
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
545
|
+
# Some parameter documentations has been truncated, see
|
546
|
+
# {Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment} for more details.
|
547
|
+
#
|
548
|
+
# @param id [String]
|
549
|
+
#
|
550
|
+
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
551
|
+
#
|
552
|
+
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
553
|
+
# ...
|
554
|
+
#
|
555
|
+
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
556
|
+
# ...
|
557
|
+
#
|
558
|
+
# @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
|
559
|
+
#
|
560
|
+
# @param reason [String, nil] The reason for the adjustment.
|
561
|
+
#
|
562
|
+
# @param adjustment_type [Symbol, :maximum]
|
575
563
|
end
|
576
564
|
|
577
|
-
# @!
|
578
|
-
#
|
579
|
-
# def self.variants; end
|
565
|
+
# @!method self.variants
|
566
|
+
# @return [Array(Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment)]
|
580
567
|
end
|
581
568
|
|
582
569
|
# @see Orb::Models::Plan#base_plan
|
@@ -599,14 +586,16 @@ module Orb
|
|
599
586
|
# @return [String, nil]
|
600
587
|
required :name, String, nil?: true
|
601
588
|
|
602
|
-
# @!
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
#
|
607
|
-
#
|
608
|
-
|
609
|
-
#
|
589
|
+
# @!method initialize(id:, external_plan_id:, name:)
|
590
|
+
# Some parameter documentations has been truncated, see
|
591
|
+
# {Orb::Models::Plan::BasePlan} for more details.
|
592
|
+
#
|
593
|
+
# @param id [String, nil]
|
594
|
+
#
|
595
|
+
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
596
|
+
# ...
|
597
|
+
#
|
598
|
+
# @param name [String, nil]
|
610
599
|
end
|
611
600
|
|
612
601
|
# @see Orb::Models::Plan#maximum
|
@@ -624,13 +613,14 @@ module Orb
|
|
624
613
|
# @return [String]
|
625
614
|
required :maximum_amount, String
|
626
615
|
|
627
|
-
# @!
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
|
633
|
-
#
|
616
|
+
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
617
|
+
# Some parameter documentations has been truncated, see
|
618
|
+
# {Orb::Models::Plan::Maximum} for more details.
|
619
|
+
#
|
620
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
621
|
+
# ...
|
622
|
+
#
|
623
|
+
# @param maximum_amount [String] Maximum amount applied
|
634
624
|
end
|
635
625
|
|
636
626
|
# @see Orb::Models::Plan#minimum
|
@@ -648,13 +638,14 @@ module Orb
|
|
648
638
|
# @return [String]
|
649
639
|
required :minimum_amount, String
|
650
640
|
|
651
|
-
# @!
|
652
|
-
#
|
653
|
-
#
|
654
|
-
#
|
655
|
-
#
|
656
|
-
|
657
|
-
#
|
641
|
+
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
642
|
+
# Some parameter documentations has been truncated, see
|
643
|
+
# {Orb::Models::Plan::Minimum} for more details.
|
644
|
+
#
|
645
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
646
|
+
# ...
|
647
|
+
#
|
648
|
+
# @param minimum_amount [String] Minimum amount applied
|
658
649
|
end
|
659
650
|
|
660
651
|
class PlanPhase < Orb::Internal::Type::BaseModel
|
@@ -716,37 +707,32 @@ module Orb
|
|
716
707
|
# @return [Integer]
|
717
708
|
required :order, Integer
|
718
709
|
|
719
|
-
# @!
|
720
|
-
#
|
721
|
-
#
|
722
|
-
#
|
723
|
-
#
|
724
|
-
#
|
725
|
-
#
|
726
|
-
#
|
727
|
-
#
|
728
|
-
#
|
729
|
-
#
|
730
|
-
#
|
731
|
-
#
|
732
|
-
#
|
733
|
-
#
|
734
|
-
#
|
735
|
-
#
|
736
|
-
#
|
737
|
-
#
|
738
|
-
#
|
739
|
-
#
|
740
|
-
#
|
741
|
-
#
|
742
|
-
#
|
743
|
-
#
|
744
|
-
#
|
745
|
-
# )
|
746
|
-
# super
|
747
|
-
# end
|
748
|
-
|
749
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
710
|
+
# @!method initialize(id:, description:, discount:, duration:, duration_unit:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, order:)
|
711
|
+
# Some parameter documentations has been truncated, see
|
712
|
+
# {Orb::Models::Plan::PlanPhase} for more details.
|
713
|
+
#
|
714
|
+
# @param id [String]
|
715
|
+
#
|
716
|
+
# @param description [String, nil]
|
717
|
+
#
|
718
|
+
# @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
719
|
+
#
|
720
|
+
# @param duration [Integer, nil] How many terms of length `duration_unit` this phase is active for. If null, this
|
721
|
+
# ...
|
722
|
+
#
|
723
|
+
# @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
|
724
|
+
#
|
725
|
+
# @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil]
|
726
|
+
#
|
727
|
+
# @param maximum_amount [String, nil]
|
728
|
+
#
|
729
|
+
# @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil]
|
730
|
+
#
|
731
|
+
# @param minimum_amount [String, nil]
|
732
|
+
#
|
733
|
+
# @param name [String]
|
734
|
+
#
|
735
|
+
# @param order [Integer] Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
|
750
736
|
|
751
737
|
# @see Orb::Models::Plan::PlanPhase#duration_unit
|
752
738
|
module DurationUnit
|
@@ -758,11 +744,8 @@ module Orb
|
|
758
744
|
SEMI_ANNUAL = :semi_annual
|
759
745
|
ANNUAL = :annual
|
760
746
|
|
761
|
-
|
762
|
-
|
763
|
-
# @!parse
|
764
|
-
# # @return [Array<Symbol>]
|
765
|
-
# def self.values; end
|
747
|
+
# @!method self.values
|
748
|
+
# @return [Array<Symbol>]
|
766
749
|
end
|
767
750
|
|
768
751
|
# @see Orb::Models::Plan::PlanPhase#maximum
|
@@ -780,13 +763,14 @@ module Orb
|
|
780
763
|
# @return [String]
|
781
764
|
required :maximum_amount, String
|
782
765
|
|
783
|
-
# @!
|
784
|
-
#
|
785
|
-
#
|
786
|
-
#
|
787
|
-
#
|
788
|
-
|
789
|
-
#
|
766
|
+
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
767
|
+
# Some parameter documentations has been truncated, see
|
768
|
+
# {Orb::Models::Plan::PlanPhase::Maximum} for more details.
|
769
|
+
#
|
770
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
771
|
+
# ...
|
772
|
+
#
|
773
|
+
# @param maximum_amount [String] Maximum amount applied
|
790
774
|
end
|
791
775
|
|
792
776
|
# @see Orb::Models::Plan::PlanPhase#minimum
|
@@ -804,13 +788,14 @@ module Orb
|
|
804
788
|
# @return [String]
|
805
789
|
required :minimum_amount, String
|
806
790
|
|
807
|
-
# @!
|
808
|
-
#
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
812
|
-
|
813
|
-
#
|
791
|
+
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
792
|
+
# Some parameter documentations has been truncated, see
|
793
|
+
# {Orb::Models::Plan::PlanPhase::Minimum} for more details.
|
794
|
+
#
|
795
|
+
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
796
|
+
# ...
|
797
|
+
#
|
798
|
+
# @param minimum_amount [String] Minimum amount applied
|
814
799
|
end
|
815
800
|
end
|
816
801
|
|
@@ -831,14 +816,10 @@ module Orb
|
|
831
816
|
# @return [String]
|
832
817
|
required :name, String
|
833
818
|
|
834
|
-
# @!
|
835
|
-
#
|
836
|
-
#
|
837
|
-
#
|
838
|
-
# #
|
839
|
-
# def initialize(id:, created_at:, name:, **) = super
|
840
|
-
|
841
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
819
|
+
# @!method initialize(id:, created_at:, name:)
|
820
|
+
# @param id [String]
|
821
|
+
# @param created_at [Time]
|
822
|
+
# @param name [String]
|
842
823
|
end
|
843
824
|
|
844
825
|
# @see Orb::Models::Plan#status
|
@@ -849,11 +830,8 @@ module Orb
|
|
849
830
|
ARCHIVED = :archived
|
850
831
|
DRAFT = :draft
|
851
832
|
|
852
|
-
|
853
|
-
|
854
|
-
# @!parse
|
855
|
-
# # @return [Array<Symbol>]
|
856
|
-
# def self.values; end
|
833
|
+
# @!method self.values
|
834
|
+
# @return [Array<Symbol>]
|
857
835
|
end
|
858
836
|
|
859
837
|
# @see Orb::Models::Plan#trial_config
|
@@ -868,13 +846,9 @@ module Orb
|
|
868
846
|
# @return [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
|
869
847
|
required :trial_period_unit, enum: -> { Orb::Models::Plan::TrialConfig::TrialPeriodUnit }
|
870
848
|
|
871
|
-
# @!
|
872
|
-
#
|
873
|
-
#
|
874
|
-
# #
|
875
|
-
# def initialize(trial_period:, trial_period_unit:, **) = super
|
876
|
-
|
877
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
849
|
+
# @!method initialize(trial_period:, trial_period_unit:)
|
850
|
+
# @param trial_period [Integer, nil]
|
851
|
+
# @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
|
878
852
|
|
879
853
|
# @see Orb::Models::Plan::TrialConfig#trial_period_unit
|
880
854
|
module TrialPeriodUnit
|
@@ -882,11 +856,8 @@ module Orb
|
|
882
856
|
|
883
857
|
DAYS = :days
|
884
858
|
|
885
|
-
|
886
|
-
|
887
|
-
# @!parse
|
888
|
-
# # @return [Array<Symbol>]
|
889
|
-
# def self.values; end
|
859
|
+
# @!method self.values
|
860
|
+
# @return [Array<Symbol>]
|
890
861
|
end
|
891
862
|
end
|
892
863
|
end
|