orb-billing 0.2.0 → 0.3.1
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 +67 -0
- data/README.md +63 -53
- data/lib/orb/client.rb +4 -4
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +7 -11
- data/lib/orb/internal/transport/base_client.rb +10 -10
- 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 +33 -23
- data/lib/orb/internal/type/base_page.rb +9 -1
- data/lib/orb/internal/type/boolean.rb +14 -11
- data/lib/orb/internal/type/converter.rb +4 -1
- data/lib/orb/internal/type/enum.rb +19 -16
- 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 +3 -10
- data/lib/orb/internal/type/union.rb +10 -1
- data/lib/orb/internal/type/unknown.rb +14 -11
- data/lib/orb/internal/util.rb +88 -64
- 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 +29 -34
- 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 +216 -257
- 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 +212 -257
- data/lib/orb/models/customer_update_params.rb +212 -255
- 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 +23 -27
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +23 -27
- 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 +384 -491
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
- 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 +384 -494
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
- 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 +619 -681
- 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 +618 -669
- 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 +281 -306
- 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 +259 -291
- data/lib/orb/models/plan_create_params.rb +2070 -2466
- 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 +3842 -5005
- 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 +360 -405
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +358 -399
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +384 -418
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
- data/lib/orb/models/subscription_create_params.rb +4735 -5417
- data/lib/orb/models/subscription_create_response.rb +358 -399
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
- 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 +2560 -3040
- data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
- 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 +362 -396
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
- 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 +360 -399
- 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/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -6
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +26 -8
- 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 +112 -32
- 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 +138 -39
- 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 +9 -3
- data/lib/orb/resources/prices.rb +101 -26
- 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 → orb}/client.rbi +4 -4
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/orb/file_part.rbi +34 -0
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
- data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
- data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
- data/rbi/{lib/orb → orb}/internal.rbi +0 -1
- data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
- data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
- data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
- data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
- data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- 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 +16 -12
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +230 -224
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -12,11 +12,11 @@ module Orb
|
|
12
12
|
returns(
|
13
13
|
T::Array[
|
14
14
|
T.any(
|
15
|
-
Orb::Models::Plan::Adjustment::
|
16
|
-
Orb::Models::Plan::Adjustment::
|
17
|
-
Orb::Models::Plan::Adjustment::
|
18
|
-
Orb::Models::Plan::Adjustment::
|
19
|
-
Orb::Models::Plan::Adjustment::
|
15
|
+
Orb::Models::Plan::Adjustment::UsageDiscount,
|
16
|
+
Orb::Models::Plan::Adjustment::AmountDiscount,
|
17
|
+
Orb::Models::Plan::Adjustment::PercentageDiscount,
|
18
|
+
Orb::Models::Plan::Adjustment::Minimum,
|
19
|
+
Orb::Models::Plan::Adjustment::Maximum
|
20
20
|
)
|
21
21
|
]
|
22
22
|
)
|
@@ -120,34 +120,34 @@ module Orb
|
|
120
120
|
returns(
|
121
121
|
T::Array[
|
122
122
|
T.any(
|
123
|
-
Orb::Models::Price::
|
124
|
-
Orb::Models::Price::
|
125
|
-
Orb::Models::Price::
|
126
|
-
Orb::Models::Price::
|
127
|
-
Orb::Models::Price::
|
128
|
-
Orb::Models::Price::
|
129
|
-
Orb::Models::Price::
|
130
|
-
Orb::Models::Price::
|
131
|
-
Orb::Models::Price::
|
132
|
-
Orb::Models::Price::
|
133
|
-
Orb::Models::Price::
|
134
|
-
Orb::Models::Price::
|
135
|
-
Orb::Models::Price::
|
136
|
-
Orb::Models::Price::
|
137
|
-
Orb::Models::Price::
|
138
|
-
Orb::Models::Price::
|
139
|
-
Orb::Models::Price::
|
140
|
-
Orb::Models::Price::
|
141
|
-
Orb::Models::Price::
|
142
|
-
Orb::Models::Price::
|
143
|
-
Orb::Models::Price::
|
144
|
-
Orb::Models::Price::
|
145
|
-
Orb::Models::Price::
|
146
|
-
Orb::Models::Price::
|
147
|
-
Orb::Models::Price::
|
148
|
-
Orb::Models::Price::
|
149
|
-
Orb::Models::Price::
|
150
|
-
Orb::Models::Price::
|
123
|
+
Orb::Models::Price::Unit,
|
124
|
+
Orb::Models::Price::Package,
|
125
|
+
Orb::Models::Price::Matrix,
|
126
|
+
Orb::Models::Price::Tiered,
|
127
|
+
Orb::Models::Price::TieredBps,
|
128
|
+
Orb::Models::Price::Bps,
|
129
|
+
Orb::Models::Price::BulkBps,
|
130
|
+
Orb::Models::Price::Bulk,
|
131
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
132
|
+
Orb::Models::Price::TieredPackage,
|
133
|
+
Orb::Models::Price::GroupedTiered,
|
134
|
+
Orb::Models::Price::TieredWithMinimum,
|
135
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
136
|
+
Orb::Models::Price::PackageWithAllocation,
|
137
|
+
Orb::Models::Price::UnitWithPercent,
|
138
|
+
Orb::Models::Price::MatrixWithAllocation,
|
139
|
+
Orb::Models::Price::TieredWithProration,
|
140
|
+
Orb::Models::Price::UnitWithProration,
|
141
|
+
Orb::Models::Price::GroupedAllocation,
|
142
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
143
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
144
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
145
|
+
Orb::Models::Price::BulkWithProration,
|
146
|
+
Orb::Models::Price::GroupedTieredPackage,
|
147
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
148
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
149
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
150
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
151
151
|
)
|
152
152
|
]
|
153
153
|
)
|
@@ -181,12 +181,12 @@ module Orb
|
|
181
181
|
id: String,
|
182
182
|
adjustments: T::Array[
|
183
183
|
T.any(
|
184
|
-
Orb::Models::Plan::Adjustment::
|
184
|
+
Orb::Models::Plan::Adjustment::UsageDiscount,
|
185
185
|
Orb::Internal::AnyHash,
|
186
|
-
Orb::Models::Plan::Adjustment::
|
187
|
-
Orb::Models::Plan::Adjustment::
|
188
|
-
Orb::Models::Plan::Adjustment::
|
189
|
-
Orb::Models::Plan::Adjustment::
|
186
|
+
Orb::Models::Plan::Adjustment::AmountDiscount,
|
187
|
+
Orb::Models::Plan::Adjustment::PercentageDiscount,
|
188
|
+
Orb::Models::Plan::Adjustment::Minimum,
|
189
|
+
Orb::Models::Plan::Adjustment::Maximum
|
190
190
|
)
|
191
191
|
],
|
192
192
|
base_plan: T.nilable(T.any(Orb::Models::Plan::BasePlan, Orb::Internal::AnyHash)),
|
@@ -216,35 +216,35 @@ module Orb
|
|
216
216
|
plan_phases: T.nilable(T::Array[T.any(Orb::Models::Plan::PlanPhase, Orb::Internal::AnyHash)]),
|
217
217
|
prices: T::Array[
|
218
218
|
T.any(
|
219
|
-
Orb::Models::Price::
|
219
|
+
Orb::Models::Price::Unit,
|
220
220
|
Orb::Internal::AnyHash,
|
221
|
-
Orb::Models::Price::
|
222
|
-
Orb::Models::Price::
|
223
|
-
Orb::Models::Price::
|
224
|
-
Orb::Models::Price::
|
225
|
-
Orb::Models::Price::
|
226
|
-
Orb::Models::Price::
|
227
|
-
Orb::Models::Price::
|
228
|
-
Orb::Models::Price::
|
229
|
-
Orb::Models::Price::
|
230
|
-
Orb::Models::Price::
|
231
|
-
Orb::Models::Price::
|
232
|
-
Orb::Models::Price::
|
233
|
-
Orb::Models::Price::
|
234
|
-
Orb::Models::Price::
|
235
|
-
Orb::Models::Price::
|
236
|
-
Orb::Models::Price::
|
237
|
-
Orb::Models::Price::
|
238
|
-
Orb::Models::Price::
|
239
|
-
Orb::Models::Price::
|
240
|
-
Orb::Models::Price::
|
241
|
-
Orb::Models::Price::
|
242
|
-
Orb::Models::Price::
|
243
|
-
Orb::Models::Price::
|
244
|
-
Orb::Models::Price::
|
245
|
-
Orb::Models::Price::
|
246
|
-
Orb::Models::Price::
|
247
|
-
Orb::Models::Price::
|
221
|
+
Orb::Models::Price::Package,
|
222
|
+
Orb::Models::Price::Matrix,
|
223
|
+
Orb::Models::Price::Tiered,
|
224
|
+
Orb::Models::Price::TieredBps,
|
225
|
+
Orb::Models::Price::Bps,
|
226
|
+
Orb::Models::Price::BulkBps,
|
227
|
+
Orb::Models::Price::Bulk,
|
228
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
229
|
+
Orb::Models::Price::TieredPackage,
|
230
|
+
Orb::Models::Price::GroupedTiered,
|
231
|
+
Orb::Models::Price::TieredWithMinimum,
|
232
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
233
|
+
Orb::Models::Price::PackageWithAllocation,
|
234
|
+
Orb::Models::Price::UnitWithPercent,
|
235
|
+
Orb::Models::Price::MatrixWithAllocation,
|
236
|
+
Orb::Models::Price::TieredWithProration,
|
237
|
+
Orb::Models::Price::UnitWithProration,
|
238
|
+
Orb::Models::Price::GroupedAllocation,
|
239
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
240
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
241
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
242
|
+
Orb::Models::Price::BulkWithProration,
|
243
|
+
Orb::Models::Price::GroupedTieredPackage,
|
244
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
245
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
246
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
247
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
248
248
|
)
|
249
249
|
],
|
250
250
|
product: T.any(Orb::Models::Plan::Product, Orb::Internal::AnyHash),
|
@@ -256,24 +256,48 @@ module Orb
|
|
256
256
|
end
|
257
257
|
def self.new(
|
258
258
|
id:,
|
259
|
+
# Adjustments for this plan. If the plan has phases, this includes adjustments
|
260
|
+
# across all phases of the plan.
|
259
261
|
adjustments:,
|
260
262
|
base_plan:,
|
263
|
+
# The parent plan id if the given plan was created by overriding one or more of
|
264
|
+
# the parent's prices
|
261
265
|
base_plan_id:,
|
262
266
|
created_at:,
|
267
|
+
# An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
|
268
|
+
# prices.
|
263
269
|
currency:,
|
270
|
+
# The default memo text on the invoices corresponding to subscriptions on this
|
271
|
+
# plan. Note that each subscription may configure its own memo.
|
264
272
|
default_invoice_memo:,
|
265
273
|
description:,
|
266
274
|
discount:,
|
275
|
+
# An optional user-defined ID for this plan resource, used throughout the system
|
276
|
+
# as an alias for this Plan. Use this field to identify a plan by an existing
|
277
|
+
# identifier in your system.
|
267
278
|
external_plan_id:,
|
279
|
+
# An ISO 4217 currency string for which this plan is billed in. Matches `currency`
|
280
|
+
# unless `currency` is a custom pricing unit.
|
268
281
|
invoicing_currency:,
|
269
282
|
maximum:,
|
270
283
|
maximum_amount:,
|
284
|
+
# User specified key-value pairs for the resource. If not present, this defaults
|
285
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
286
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
287
|
+
# `null`.
|
271
288
|
metadata:,
|
272
289
|
minimum:,
|
273
290
|
minimum_amount:,
|
274
291
|
name:,
|
292
|
+
# Determines the difference between the invoice issue date and the due date. A
|
293
|
+
# value of "0" here signifies that invoices are due on issue, whereas a value of
|
294
|
+
# "30" means that the customer has a month to pay the invoice before its overdue.
|
295
|
+
# Note that individual subscriptions or invoices may set a different net terms
|
296
|
+
# configuration.
|
275
297
|
net_terms:,
|
276
298
|
plan_phases:,
|
299
|
+
# Prices for this plan. If the plan has phases, this includes prices across all
|
300
|
+
# phases of the plan.
|
277
301
|
prices:,
|
278
302
|
product:,
|
279
303
|
status:,
|
@@ -287,11 +311,11 @@ module Orb
|
|
287
311
|
id: String,
|
288
312
|
adjustments: T::Array[
|
289
313
|
T.any(
|
290
|
-
Orb::Models::Plan::Adjustment::
|
291
|
-
Orb::Models::Plan::Adjustment::
|
292
|
-
Orb::Models::Plan::Adjustment::
|
293
|
-
Orb::Models::Plan::Adjustment::
|
294
|
-
Orb::Models::Plan::Adjustment::
|
314
|
+
Orb::Models::Plan::Adjustment::UsageDiscount,
|
315
|
+
Orb::Models::Plan::Adjustment::AmountDiscount,
|
316
|
+
Orb::Models::Plan::Adjustment::PercentageDiscount,
|
317
|
+
Orb::Models::Plan::Adjustment::Minimum,
|
318
|
+
Orb::Models::Plan::Adjustment::Maximum
|
295
319
|
)
|
296
320
|
],
|
297
321
|
base_plan: T.nilable(Orb::Models::Plan::BasePlan),
|
@@ -320,34 +344,34 @@ module Orb
|
|
320
344
|
plan_phases: T.nilable(T::Array[Orb::Models::Plan::PlanPhase]),
|
321
345
|
prices: T::Array[
|
322
346
|
T.any(
|
323
|
-
Orb::Models::Price::
|
324
|
-
Orb::Models::Price::
|
325
|
-
Orb::Models::Price::
|
326
|
-
Orb::Models::Price::
|
327
|
-
Orb::Models::Price::
|
328
|
-
Orb::Models::Price::
|
329
|
-
Orb::Models::Price::
|
330
|
-
Orb::Models::Price::
|
331
|
-
Orb::Models::Price::
|
332
|
-
Orb::Models::Price::
|
333
|
-
Orb::Models::Price::
|
334
|
-
Orb::Models::Price::
|
335
|
-
Orb::Models::Price::
|
336
|
-
Orb::Models::Price::
|
337
|
-
Orb::Models::Price::
|
338
|
-
Orb::Models::Price::
|
339
|
-
Orb::Models::Price::
|
340
|
-
Orb::Models::Price::
|
341
|
-
Orb::Models::Price::
|
342
|
-
Orb::Models::Price::
|
343
|
-
Orb::Models::Price::
|
344
|
-
Orb::Models::Price::
|
345
|
-
Orb::Models::Price::
|
346
|
-
Orb::Models::Price::
|
347
|
-
Orb::Models::Price::
|
348
|
-
Orb::Models::Price::
|
349
|
-
Orb::Models::Price::
|
350
|
-
Orb::Models::Price::
|
347
|
+
Orb::Models::Price::Unit,
|
348
|
+
Orb::Models::Price::Package,
|
349
|
+
Orb::Models::Price::Matrix,
|
350
|
+
Orb::Models::Price::Tiered,
|
351
|
+
Orb::Models::Price::TieredBps,
|
352
|
+
Orb::Models::Price::Bps,
|
353
|
+
Orb::Models::Price::BulkBps,
|
354
|
+
Orb::Models::Price::Bulk,
|
355
|
+
Orb::Models::Price::ThresholdTotalAmount,
|
356
|
+
Orb::Models::Price::TieredPackage,
|
357
|
+
Orb::Models::Price::GroupedTiered,
|
358
|
+
Orb::Models::Price::TieredWithMinimum,
|
359
|
+
Orb::Models::Price::TieredPackageWithMinimum,
|
360
|
+
Orb::Models::Price::PackageWithAllocation,
|
361
|
+
Orb::Models::Price::UnitWithPercent,
|
362
|
+
Orb::Models::Price::MatrixWithAllocation,
|
363
|
+
Orb::Models::Price::TieredWithProration,
|
364
|
+
Orb::Models::Price::UnitWithProration,
|
365
|
+
Orb::Models::Price::GroupedAllocation,
|
366
|
+
Orb::Models::Price::GroupedWithProratedMinimum,
|
367
|
+
Orb::Models::Price::GroupedWithMeteredMinimum,
|
368
|
+
Orb::Models::Price::MatrixWithDisplayName,
|
369
|
+
Orb::Models::Price::BulkWithProration,
|
370
|
+
Orb::Models::Price::GroupedTieredPackage,
|
371
|
+
Orb::Models::Price::MaxGroupTieredPackage,
|
372
|
+
Orb::Models::Price::ScalableMatrixWithUnitPricing,
|
373
|
+
Orb::Models::Price::ScalableMatrixWithTieredPricing,
|
374
|
+
Orb::Models::Price::CumulativeGroupedBulk
|
351
375
|
)
|
352
376
|
],
|
353
377
|
product: Orb::Models::Plan::Product,
|
@@ -362,7 +386,7 @@ module Orb
|
|
362
386
|
module Adjustment
|
363
387
|
extend Orb::Internal::Type::Union
|
364
388
|
|
365
|
-
class
|
389
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
366
390
|
sig { returns(String) }
|
367
391
|
attr_accessor :id
|
368
392
|
|
@@ -405,10 +429,17 @@ module Orb
|
|
405
429
|
end
|
406
430
|
def self.new(
|
407
431
|
id:,
|
432
|
+
# The price IDs that this adjustment applies to.
|
408
433
|
applies_to_price_ids:,
|
434
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
435
|
+
# that apply to only one price.
|
409
436
|
is_invoice_level:,
|
437
|
+
# The plan phase in which this adjustment is active.
|
410
438
|
plan_phase_order:,
|
439
|
+
# The reason for the adjustment.
|
411
440
|
reason:,
|
441
|
+
# The number of usage units by which to discount the price this adjustment applies
|
442
|
+
# to in a given billing period.
|
412
443
|
usage_discount:,
|
413
444
|
adjustment_type: :usage_discount
|
414
445
|
); end
|
@@ -429,7 +460,7 @@ module Orb
|
|
429
460
|
def to_hash; end
|
430
461
|
end
|
431
462
|
|
432
|
-
class
|
463
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
433
464
|
sig { returns(String) }
|
434
465
|
attr_accessor :id
|
435
466
|
|
@@ -472,10 +503,17 @@ module Orb
|
|
472
503
|
end
|
473
504
|
def self.new(
|
474
505
|
id:,
|
506
|
+
# The amount by which to discount the prices this adjustment applies to in a given
|
507
|
+
# billing period.
|
475
508
|
amount_discount:,
|
509
|
+
# The price IDs that this adjustment applies to.
|
476
510
|
applies_to_price_ids:,
|
511
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
512
|
+
# that apply to only one price.
|
477
513
|
is_invoice_level:,
|
514
|
+
# The plan phase in which this adjustment is active.
|
478
515
|
plan_phase_order:,
|
516
|
+
# The reason for the adjustment.
|
479
517
|
reason:,
|
480
518
|
adjustment_type: :amount_discount
|
481
519
|
); end
|
@@ -496,7 +534,7 @@ module Orb
|
|
496
534
|
def to_hash; end
|
497
535
|
end
|
498
536
|
|
499
|
-
class
|
537
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
500
538
|
sig { returns(String) }
|
501
539
|
attr_accessor :id
|
502
540
|
|
@@ -539,10 +577,17 @@ module Orb
|
|
539
577
|
end
|
540
578
|
def self.new(
|
541
579
|
id:,
|
580
|
+
# The price IDs that this adjustment applies to.
|
542
581
|
applies_to_price_ids:,
|
582
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
583
|
+
# that apply to only one price.
|
543
584
|
is_invoice_level:,
|
585
|
+
# The percentage (as a value between 0 and 1) by which to discount the price
|
586
|
+
# intervals this adjustment applies to in a given billing period.
|
544
587
|
percentage_discount:,
|
588
|
+
# The plan phase in which this adjustment is active.
|
545
589
|
plan_phase_order:,
|
590
|
+
# The reason for the adjustment.
|
546
591
|
reason:,
|
547
592
|
adjustment_type: :percentage_discount
|
548
593
|
); end
|
@@ -563,7 +608,7 @@ module Orb
|
|
563
608
|
def to_hash; end
|
564
609
|
end
|
565
610
|
|
566
|
-
class
|
611
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
567
612
|
sig { returns(String) }
|
568
613
|
attr_accessor :id
|
569
614
|
|
@@ -611,11 +656,19 @@ module Orb
|
|
611
656
|
end
|
612
657
|
def self.new(
|
613
658
|
id:,
|
659
|
+
# The price IDs that this adjustment applies to.
|
614
660
|
applies_to_price_ids:,
|
661
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
662
|
+
# that apply to only one price.
|
615
663
|
is_invoice_level:,
|
664
|
+
# The item ID that revenue from this minimum will be attributed to.
|
616
665
|
item_id:,
|
666
|
+
# The minimum amount to charge in a given billing period for the prices this
|
667
|
+
# adjustment applies to.
|
617
668
|
minimum_amount:,
|
669
|
+
# The plan phase in which this adjustment is active.
|
618
670
|
plan_phase_order:,
|
671
|
+
# The reason for the adjustment.
|
619
672
|
reason:,
|
620
673
|
adjustment_type: :minimum
|
621
674
|
); end
|
@@ -637,7 +690,7 @@ module Orb
|
|
637
690
|
def to_hash; end
|
638
691
|
end
|
639
692
|
|
640
|
-
class
|
693
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
641
694
|
sig { returns(String) }
|
642
695
|
attr_accessor :id
|
643
696
|
|
@@ -680,10 +733,17 @@ module Orb
|
|
680
733
|
end
|
681
734
|
def self.new(
|
682
735
|
id:,
|
736
|
+
# The price IDs that this adjustment applies to.
|
683
737
|
applies_to_price_ids:,
|
738
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
739
|
+
# that apply to only one price.
|
684
740
|
is_invoice_level:,
|
741
|
+
# The maximum amount to charge in a given billing period for the prices this
|
742
|
+
# adjustment applies to.
|
685
743
|
maximum_amount:,
|
744
|
+
# The plan phase in which this adjustment is active.
|
686
745
|
plan_phase_order:,
|
746
|
+
# The reason for the adjustment.
|
687
747
|
reason:,
|
688
748
|
adjustment_type: :maximum
|
689
749
|
); end
|
@@ -707,7 +767,7 @@ module Orb
|
|
707
767
|
sig do
|
708
768
|
override
|
709
769
|
.returns(
|
710
|
-
[Orb::Models::Plan::Adjustment::
|
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]
|
711
771
|
)
|
712
772
|
end
|
713
773
|
def self.variants; end
|
@@ -730,8 +790,14 @@ module Orb
|
|
730
790
|
params(id: T.nilable(String), external_plan_id: T.nilable(String), name: T.nilable(String))
|
731
791
|
.returns(T.attached_class)
|
732
792
|
end
|
733
|
-
def self.new(
|
734
|
-
|
793
|
+
def self.new(
|
794
|
+
id:,
|
795
|
+
# An optional user-defined ID for this plan resource, used throughout the system
|
796
|
+
# as an alias for this Plan. Use this field to identify a plan by an existing
|
797
|
+
# identifier in your system.
|
798
|
+
external_plan_id:,
|
799
|
+
name:
|
800
|
+
); end
|
735
801
|
sig do
|
736
802
|
override.returns(
|
737
803
|
{
|
@@ -757,8 +823,13 @@ module Orb
|
|
757
823
|
sig do
|
758
824
|
params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
|
759
825
|
end
|
760
|
-
def self.new(
|
761
|
-
|
826
|
+
def self.new(
|
827
|
+
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
828
|
+
# maximums, this can be a subset of prices.
|
829
|
+
applies_to_price_ids:,
|
830
|
+
# Maximum amount applied
|
831
|
+
maximum_amount:
|
832
|
+
); end
|
762
833
|
sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
|
763
834
|
def to_hash; end
|
764
835
|
end
|
@@ -776,8 +847,13 @@ module Orb
|
|
776
847
|
sig do
|
777
848
|
params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
|
778
849
|
end
|
779
|
-
def self.new(
|
780
|
-
|
850
|
+
def self.new(
|
851
|
+
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
852
|
+
# minimums, this can be a subset of prices.
|
853
|
+
applies_to_price_ids:,
|
854
|
+
# Minimum amount applied
|
855
|
+
minimum_amount:
|
856
|
+
); end
|
781
857
|
sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
|
782
858
|
def to_hash; end
|
783
859
|
end
|
@@ -864,6 +940,8 @@ module Orb
|
|
864
940
|
id:,
|
865
941
|
description:,
|
866
942
|
discount:,
|
943
|
+
# How many terms of length `duration_unit` this phase is active for. If null, this
|
944
|
+
# phase is evergreen and active indefinitely
|
867
945
|
duration:,
|
868
946
|
duration_unit:,
|
869
947
|
maximum:,
|
@@ -871,6 +949,7 @@ module Orb
|
|
871
949
|
minimum:,
|
872
950
|
minimum_amount:,
|
873
951
|
name:,
|
952
|
+
# Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
|
874
953
|
order:
|
875
954
|
); end
|
876
955
|
sig do
|
@@ -904,8 +983,7 @@ module Orb
|
|
904
983
|
extend Orb::Internal::Type::Enum
|
905
984
|
|
906
985
|
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::PlanPhase::DurationUnit) }
|
907
|
-
OrSymbol =
|
908
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) }
|
986
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
909
987
|
|
910
988
|
DAILY = T.let(:daily, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol)
|
911
989
|
MONTHLY = T.let(:monthly, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol)
|
@@ -930,8 +1008,13 @@ module Orb
|
|
930
1008
|
sig do
|
931
1009
|
params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
|
932
1010
|
end
|
933
|
-
def self.new(
|
934
|
-
|
1011
|
+
def self.new(
|
1012
|
+
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
1013
|
+
# maximums, this can be a subset of prices.
|
1014
|
+
applies_to_price_ids:,
|
1015
|
+
# Maximum amount applied
|
1016
|
+
maximum_amount:
|
1017
|
+
); end
|
935
1018
|
sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
|
936
1019
|
def to_hash; end
|
937
1020
|
end
|
@@ -949,8 +1032,13 @@ module Orb
|
|
949
1032
|
sig do
|
950
1033
|
params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
|
951
1034
|
end
|
952
|
-
def self.new(
|
953
|
-
|
1035
|
+
def self.new(
|
1036
|
+
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
1037
|
+
# minimums, this can be a subset of prices.
|
1038
|
+
applies_to_price_ids:,
|
1039
|
+
# Minimum amount applied
|
1040
|
+
minimum_amount:
|
1041
|
+
); end
|
954
1042
|
sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
|
955
1043
|
def to_hash; end
|
956
1044
|
end
|
@@ -977,7 +1065,7 @@ module Orb
|
|
977
1065
|
extend Orb::Internal::Type::Enum
|
978
1066
|
|
979
1067
|
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::Status) }
|
980
|
-
OrSymbol = T.type_alias { T.any(Symbol, String
|
1068
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
981
1069
|
|
982
1070
|
ACTIVE = T.let(:active, Orb::Models::Plan::Status::TaggedSymbol)
|
983
1071
|
ARCHIVED = T.let(:archived, Orb::Models::Plan::Status::TaggedSymbol)
|
@@ -1018,8 +1106,7 @@ module Orb
|
|
1018
1106
|
extend Orb::Internal::Type::Enum
|
1019
1107
|
|
1020
1108
|
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit) }
|
1021
|
-
OrSymbol =
|
1022
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol) }
|
1109
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1023
1110
|
|
1024
1111
|
DAYS = T.let(:days, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol)
|
1025
1112
|
|