orb-billing 0.3.1 → 0.3.2
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 +14 -0
- data/README.md +3 -3
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/type/enum.rb +3 -3
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/util.rb +1 -1
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +6 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +41 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
- data/lib/orb/models/customer_update_params.rb +41 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +157 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +78 -103
- data/lib/orb/models/plan_create_params.rb +727 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1671 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +86 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +21 -57
- data/lib/orb/models/subscription_change_apply_response.rb +21 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
- data/lib/orb/models/subscription_create_params.rb +1865 -1815
- data/lib/orb/models/subscription_create_response.rb +21 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +21 -57
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +19 -6
- data/rbi/orb/internal/transport/base_client.rbi +131 -73
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +124 -65
- data/rbi/orb/internal/type/base_page.rbi +11 -7
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +66 -31
- data/rbi/orb/internal/type/enum.rbi +27 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +60 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +210 -89
- data/rbi/orb/models/alert.rbi +107 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/orb/models/alert_disable_params.rbi +17 -6
- data/rbi/orb/models/alert_enable_params.rbi +17 -6
- data/rbi/orb/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
- data/rbi/orb/models/alert_update_params.rbi +25 -14
- data/rbi/orb/models/amount_discount.rbi +28 -19
- data/rbi/orb/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +10 -4
- data/rbi/orb/models/coupon_create_params.rbi +72 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
- data/rbi/orb/models/coupon_list_params.rbi +18 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/orb/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +58 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
- data/rbi/orb/models/credit_note_list_params.rbi +20 -17
- data/rbi/orb/models/customer.rbi +430 -329
- data/rbi/orb/models/customer_create_params.rbi +662 -325
- data/rbi/orb/models/customer_delete_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_params.rbi +10 -4
- data/rbi/orb/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
- data/rbi/orb/models/customer_update_params.rbi +661 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/orb/models/dimensional_price_group.rbi +18 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
- data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +10 -4
- data/rbi/orb/models/event_deprecate_response.rbi +8 -3
- data/rbi/orb/models/event_ingest_params.rbi +37 -31
- data/rbi/orb/models/event_ingest_response.rbi +63 -23
- data/rbi/orb/models/event_search_params.rbi +17 -14
- data/rbi/orb/models/event_search_response.rbi +33 -21
- data/rbi/orb/models/event_update_params.rbi +19 -16
- data/rbi/orb/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/orb/models/events/event_volumes.rbi +32 -10
- data/rbi/orb/models/events/volume_list_params.rbi +18 -15
- data/rbi/orb/models/invoice.rbi +1286 -805
- data/rbi/orb/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
- data/rbi/orb/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
- data/rbi/orb/models/invoice_list_params.rbi +67 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +10 -4
- data/rbi/orb/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +10 -4
- data/rbi/orb/models/item.rbi +87 -39
- data/rbi/orb/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +10 -4
- data/rbi/orb/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +79 -39
- data/rbi/orb/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +10 -4
- data/rbi/orb/models/metric_list_params.rbi +20 -17
- data/rbi/orb/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +16 -4
- data/rbi/orb/models/percentage_discount.rbi +32 -19
- data/rbi/orb/models/plan.rbi +496 -365
- data/rbi/orb/models/plan_create_params.rbi +4785 -2875
- data/rbi/orb/models/plan_fetch_params.rbi +10 -4
- data/rbi/orb/models/plan_list_params.rbi +34 -27
- data/rbi/orb/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +9969 -5024
- data/rbi/orb/models/price_create_params.rbi +501 -245
- data/rbi/orb/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +11 -6
- data/rbi/orb/models/price_fetch_params.rbi +10 -4
- data/rbi/orb/models/price_list_params.rbi +16 -6
- data/rbi/orb/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/orb/models/subscription.rbi +578 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
- data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
- data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
- data/rbi/orb/models/subscription_create_response.rbi +700 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/orb/models/subscription_list_params.rbi +39 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
- data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
- data/rbi/orb/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
- data/rbi/orb/models/subscription_usage.rbi +271 -121
- data/rbi/orb/models/subscriptions.rbi +18 -11
- data/rbi/orb/models/top_level_ping_params.rbi +10 -4
- data/rbi/orb/models/top_level_ping_response.rbi +7 -3
- data/rbi/orb/models/trial_discount.rbi +29 -20
- data/rbi/orb/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
@@ -11,40 +11,39 @@ module Orb
|
|
11
11
|
params(
|
12
12
|
external_price_id: String,
|
13
13
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
14
|
-
request_options: Orb::
|
15
|
-
)
|
16
|
-
.
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
Orb::Models::Price::CumulativeGroupedBulk
|
46
|
-
)
|
14
|
+
request_options: Orb::RequestOptions::OrHash
|
15
|
+
).returns(
|
16
|
+
T.any(
|
17
|
+
Orb::Price::Unit,
|
18
|
+
Orb::Price::Package,
|
19
|
+
Orb::Price::Matrix,
|
20
|
+
Orb::Price::Tiered,
|
21
|
+
Orb::Price::TieredBps,
|
22
|
+
Orb::Price::Bps,
|
23
|
+
Orb::Price::BulkBps,
|
24
|
+
Orb::Price::Bulk,
|
25
|
+
Orb::Price::ThresholdTotalAmount,
|
26
|
+
Orb::Price::TieredPackage,
|
27
|
+
Orb::Price::GroupedTiered,
|
28
|
+
Orb::Price::TieredWithMinimum,
|
29
|
+
Orb::Price::TieredPackageWithMinimum,
|
30
|
+
Orb::Price::PackageWithAllocation,
|
31
|
+
Orb::Price::UnitWithPercent,
|
32
|
+
Orb::Price::MatrixWithAllocation,
|
33
|
+
Orb::Price::TieredWithProration,
|
34
|
+
Orb::Price::UnitWithProration,
|
35
|
+
Orb::Price::GroupedAllocation,
|
36
|
+
Orb::Price::GroupedWithProratedMinimum,
|
37
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
38
|
+
Orb::Price::MatrixWithDisplayName,
|
39
|
+
Orb::Price::BulkWithProration,
|
40
|
+
Orb::Price::GroupedTieredPackage,
|
41
|
+
Orb::Price::MaxGroupTieredPackage,
|
42
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
43
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
44
|
+
Orb::Price::CumulativeGroupedBulk
|
47
45
|
)
|
46
|
+
)
|
48
47
|
end
|
49
48
|
def update(
|
50
49
|
external_price_id,
|
@@ -53,50 +52,56 @@ module Orb
|
|
53
52
|
# by setting `metadata` to `null`.
|
54
53
|
metadata: nil,
|
55
54
|
request_options: {}
|
56
|
-
)
|
55
|
+
)
|
56
|
+
end
|
57
|
+
|
57
58
|
# This endpoint returns a price given an external price id. See the
|
58
59
|
# [price creation API](/api-reference/price/create-price) for more information
|
59
60
|
# about external price aliases.
|
60
61
|
sig do
|
61
|
-
params(
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
62
|
+
params(
|
63
|
+
external_price_id: String,
|
64
|
+
request_options: Orb::RequestOptions::OrHash
|
65
|
+
).returns(
|
66
|
+
T.any(
|
67
|
+
Orb::Price::Unit,
|
68
|
+
Orb::Price::Package,
|
69
|
+
Orb::Price::Matrix,
|
70
|
+
Orb::Price::Tiered,
|
71
|
+
Orb::Price::TieredBps,
|
72
|
+
Orb::Price::Bps,
|
73
|
+
Orb::Price::BulkBps,
|
74
|
+
Orb::Price::Bulk,
|
75
|
+
Orb::Price::ThresholdTotalAmount,
|
76
|
+
Orb::Price::TieredPackage,
|
77
|
+
Orb::Price::GroupedTiered,
|
78
|
+
Orb::Price::TieredWithMinimum,
|
79
|
+
Orb::Price::TieredPackageWithMinimum,
|
80
|
+
Orb::Price::PackageWithAllocation,
|
81
|
+
Orb::Price::UnitWithPercent,
|
82
|
+
Orb::Price::MatrixWithAllocation,
|
83
|
+
Orb::Price::TieredWithProration,
|
84
|
+
Orb::Price::UnitWithProration,
|
85
|
+
Orb::Price::GroupedAllocation,
|
86
|
+
Orb::Price::GroupedWithProratedMinimum,
|
87
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
88
|
+
Orb::Price::MatrixWithDisplayName,
|
89
|
+
Orb::Price::BulkWithProration,
|
90
|
+
Orb::Price::GroupedTieredPackage,
|
91
|
+
Orb::Price::MaxGroupTieredPackage,
|
92
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
93
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
94
|
+
Orb::Price::CumulativeGroupedBulk
|
93
95
|
)
|
96
|
+
)
|
97
|
+
end
|
98
|
+
def fetch(external_price_id, request_options: {})
|
94
99
|
end
|
95
|
-
def fetch(external_price_id, request_options: {}); end
|
96
100
|
|
97
101
|
# @api private
|
98
102
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
99
|
-
def self.new(client:)
|
103
|
+
def self.new(client:)
|
104
|
+
end
|
100
105
|
end
|
101
106
|
end
|
102
107
|
end
|
@@ -18,20 +18,21 @@ module Orb
|
|
18
18
|
# specification of different price model configurations possible in this endpoint.
|
19
19
|
sig do
|
20
20
|
params(
|
21
|
-
cadence: Orb::
|
21
|
+
cadence: Orb::PriceCreateParams::Cadence::OrSymbol,
|
22
22
|
currency: String,
|
23
23
|
item_id: String,
|
24
|
-
model_type: Orb::
|
24
|
+
model_type: Orb::PriceCreateParams::ModelType::OrSymbol,
|
25
25
|
name: String,
|
26
|
-
unit_config:
|
27
|
-
package_config:
|
28
|
-
matrix_config:
|
29
|
-
matrix_with_allocation_config:
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
26
|
+
unit_config: Orb::PriceCreateParams::UnitConfig::OrHash,
|
27
|
+
package_config: Orb::PriceCreateParams::PackageConfig::OrHash,
|
28
|
+
matrix_config: Orb::PriceCreateParams::MatrixConfig::OrHash,
|
29
|
+
matrix_with_allocation_config:
|
30
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::OrHash,
|
31
|
+
tiered_config: Orb::PriceCreateParams::TieredConfig::OrHash,
|
32
|
+
tiered_bps_config: Orb::PriceCreateParams::TieredBpsConfig::OrHash,
|
33
|
+
bps_config: Orb::PriceCreateParams::BpsConfig::OrHash,
|
34
|
+
bulk_bps_config: Orb::PriceCreateParams::BulkBpsConfig::OrHash,
|
35
|
+
bulk_config: Orb::PriceCreateParams::BulkConfig::OrHash,
|
35
36
|
threshold_total_amount_config: T::Hash[Symbol, T.anything],
|
36
37
|
tiered_package_config: T::Hash[Symbol, T.anything],
|
37
38
|
grouped_tiered_config: T::Hash[Symbol, T.anything],
|
@@ -49,51 +50,57 @@ module Orb
|
|
49
50
|
bulk_with_proration_config: T::Hash[Symbol, T.anything],
|
50
51
|
grouped_tiered_package_config: T::Hash[Symbol, T.anything],
|
51
52
|
scalable_matrix_with_unit_pricing_config: T::Hash[Symbol, T.anything],
|
52
|
-
scalable_matrix_with_tiered_pricing_config:
|
53
|
+
scalable_matrix_with_tiered_pricing_config:
|
54
|
+
T::Hash[Symbol, T.anything],
|
53
55
|
cumulative_grouped_bulk_config: T::Hash[Symbol, T.anything],
|
54
56
|
billable_metric_id: T.nilable(String),
|
55
57
|
billed_in_advance: T.nilable(T::Boolean),
|
56
|
-
billing_cycle_configuration:
|
58
|
+
billing_cycle_configuration:
|
59
|
+
T.nilable(
|
60
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::OrHash
|
61
|
+
),
|
57
62
|
conversion_rate: T.nilable(Float),
|
58
63
|
external_price_id: T.nilable(String),
|
59
64
|
fixed_price_quantity: T.nilable(Float),
|
60
65
|
invoice_grouping_key: T.nilable(String),
|
61
|
-
invoicing_cycle_configuration:
|
66
|
+
invoicing_cycle_configuration:
|
67
|
+
T.nilable(
|
68
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::OrHash
|
69
|
+
),
|
62
70
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
63
|
-
request_options: Orb::
|
64
|
-
)
|
65
|
-
.
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
Orb::Models::Price::CumulativeGroupedBulk
|
95
|
-
)
|
71
|
+
request_options: Orb::RequestOptions::OrHash
|
72
|
+
).returns(
|
73
|
+
T.any(
|
74
|
+
Orb::Price::Unit,
|
75
|
+
Orb::Price::Package,
|
76
|
+
Orb::Price::Matrix,
|
77
|
+
Orb::Price::Tiered,
|
78
|
+
Orb::Price::TieredBps,
|
79
|
+
Orb::Price::Bps,
|
80
|
+
Orb::Price::BulkBps,
|
81
|
+
Orb::Price::Bulk,
|
82
|
+
Orb::Price::ThresholdTotalAmount,
|
83
|
+
Orb::Price::TieredPackage,
|
84
|
+
Orb::Price::GroupedTiered,
|
85
|
+
Orb::Price::TieredWithMinimum,
|
86
|
+
Orb::Price::TieredPackageWithMinimum,
|
87
|
+
Orb::Price::PackageWithAllocation,
|
88
|
+
Orb::Price::UnitWithPercent,
|
89
|
+
Orb::Price::MatrixWithAllocation,
|
90
|
+
Orb::Price::TieredWithProration,
|
91
|
+
Orb::Price::UnitWithProration,
|
92
|
+
Orb::Price::GroupedAllocation,
|
93
|
+
Orb::Price::GroupedWithProratedMinimum,
|
94
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
95
|
+
Orb::Price::MatrixWithDisplayName,
|
96
|
+
Orb::Price::BulkWithProration,
|
97
|
+
Orb::Price::GroupedTieredPackage,
|
98
|
+
Orb::Price::MaxGroupTieredPackage,
|
99
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
100
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
101
|
+
Orb::Price::CumulativeGroupedBulk
|
96
102
|
)
|
103
|
+
)
|
97
104
|
end
|
98
105
|
def create(
|
99
106
|
# The cadence to bill for this price on.
|
@@ -159,7 +166,9 @@ module Orb
|
|
159
166
|
# by setting `metadata` to `null`.
|
160
167
|
metadata: nil,
|
161
168
|
request_options: {}
|
162
|
-
)
|
169
|
+
)
|
170
|
+
end
|
171
|
+
|
163
172
|
# This endpoint allows you to update the `metadata` property on a price. If you
|
164
173
|
# pass null for the metadata value, it will clear any existing metadata for that
|
165
174
|
# price.
|
@@ -167,40 +176,39 @@ module Orb
|
|
167
176
|
params(
|
168
177
|
price_id: String,
|
169
178
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
170
|
-
request_options: Orb::
|
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
|
-
Orb::Models::Price::CumulativeGroupedBulk
|
202
|
-
)
|
179
|
+
request_options: Orb::RequestOptions::OrHash
|
180
|
+
).returns(
|
181
|
+
T.any(
|
182
|
+
Orb::Price::Unit,
|
183
|
+
Orb::Price::Package,
|
184
|
+
Orb::Price::Matrix,
|
185
|
+
Orb::Price::Tiered,
|
186
|
+
Orb::Price::TieredBps,
|
187
|
+
Orb::Price::Bps,
|
188
|
+
Orb::Price::BulkBps,
|
189
|
+
Orb::Price::Bulk,
|
190
|
+
Orb::Price::ThresholdTotalAmount,
|
191
|
+
Orb::Price::TieredPackage,
|
192
|
+
Orb::Price::GroupedTiered,
|
193
|
+
Orb::Price::TieredWithMinimum,
|
194
|
+
Orb::Price::TieredPackageWithMinimum,
|
195
|
+
Orb::Price::PackageWithAllocation,
|
196
|
+
Orb::Price::UnitWithPercent,
|
197
|
+
Orb::Price::MatrixWithAllocation,
|
198
|
+
Orb::Price::TieredWithProration,
|
199
|
+
Orb::Price::UnitWithProration,
|
200
|
+
Orb::Price::GroupedAllocation,
|
201
|
+
Orb::Price::GroupedWithProratedMinimum,
|
202
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
203
|
+
Orb::Price::MatrixWithDisplayName,
|
204
|
+
Orb::Price::BulkWithProration,
|
205
|
+
Orb::Price::GroupedTieredPackage,
|
206
|
+
Orb::Price::MaxGroupTieredPackage,
|
207
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
208
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
209
|
+
Orb::Price::CumulativeGroupedBulk
|
203
210
|
)
|
211
|
+
)
|
204
212
|
end
|
205
213
|
def update(
|
206
214
|
price_id,
|
@@ -209,45 +217,50 @@ module Orb
|
|
209
217
|
# by setting `metadata` to `null`.
|
210
218
|
metadata: nil,
|
211
219
|
request_options: {}
|
212
|
-
)
|
220
|
+
)
|
221
|
+
end
|
222
|
+
|
213
223
|
# This endpoint is used to list all add-on prices created using the
|
214
224
|
# [price creation endpoint](/api-reference/price/create-price).
|
215
225
|
sig do
|
216
|
-
params(
|
217
|
-
.
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
|
226
|
+
params(
|
227
|
+
cursor: T.nilable(String),
|
228
|
+
limit: Integer,
|
229
|
+
request_options: Orb::RequestOptions::OrHash
|
230
|
+
).returns(
|
231
|
+
Orb::Internal::Page[
|
232
|
+
T.any(
|
233
|
+
Orb::Price::Unit,
|
234
|
+
Orb::Price::Package,
|
235
|
+
Orb::Price::Matrix,
|
236
|
+
Orb::Price::Tiered,
|
237
|
+
Orb::Price::TieredBps,
|
238
|
+
Orb::Price::Bps,
|
239
|
+
Orb::Price::BulkBps,
|
240
|
+
Orb::Price::Bulk,
|
241
|
+
Orb::Price::ThresholdTotalAmount,
|
242
|
+
Orb::Price::TieredPackage,
|
243
|
+
Orb::Price::GroupedTiered,
|
244
|
+
Orb::Price::TieredWithMinimum,
|
245
|
+
Orb::Price::TieredPackageWithMinimum,
|
246
|
+
Orb::Price::PackageWithAllocation,
|
247
|
+
Orb::Price::UnitWithPercent,
|
248
|
+
Orb::Price::MatrixWithAllocation,
|
249
|
+
Orb::Price::TieredWithProration,
|
250
|
+
Orb::Price::UnitWithProration,
|
251
|
+
Orb::Price::GroupedAllocation,
|
252
|
+
Orb::Price::GroupedWithProratedMinimum,
|
253
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
254
|
+
Orb::Price::MatrixWithDisplayName,
|
255
|
+
Orb::Price::BulkWithProration,
|
256
|
+
Orb::Price::GroupedTieredPackage,
|
257
|
+
Orb::Price::MaxGroupTieredPackage,
|
258
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
259
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
260
|
+
Orb::Price::CumulativeGroupedBulk
|
261
|
+
)
|
262
|
+
]
|
263
|
+
)
|
251
264
|
end
|
252
265
|
def list(
|
253
266
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
@@ -256,7 +269,9 @@ module Orb
|
|
256
269
|
# The number of items to fetch. Defaults to 20.
|
257
270
|
limit: nil,
|
258
271
|
request_options: {}
|
259
|
-
)
|
272
|
+
)
|
273
|
+
end
|
274
|
+
|
260
275
|
# This endpoint is used to evaluate the output of a price for a given customer and
|
261
276
|
# time range. It enables filtering and grouping the output using
|
262
277
|
# [computed properties](/extensibility/advanced-metrics#computed-properties),
|
@@ -287,9 +302,8 @@ module Orb
|
|
287
302
|
external_customer_id: T.nilable(String),
|
288
303
|
filter: T.nilable(String),
|
289
304
|
grouping_keys: T::Array[String],
|
290
|
-
request_options: Orb::
|
291
|
-
)
|
292
|
-
.returns(Orb::Models::PriceEvaluateResponse)
|
305
|
+
request_options: Orb::RequestOptions::OrHash
|
306
|
+
).returns(Orb::Models::PriceEvaluateResponse)
|
293
307
|
end
|
294
308
|
def evaluate(
|
295
309
|
price_id,
|
@@ -310,48 +324,54 @@ module Orb
|
|
310
324
|
# to group the underlying billable metric
|
311
325
|
grouping_keys: nil,
|
312
326
|
request_options: {}
|
313
|
-
)
|
327
|
+
)
|
328
|
+
end
|
329
|
+
|
314
330
|
# This endpoint returns a price given an identifier.
|
315
331
|
sig do
|
316
|
-
params(
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
|
347
|
-
|
332
|
+
params(
|
333
|
+
price_id: String,
|
334
|
+
request_options: Orb::RequestOptions::OrHash
|
335
|
+
).returns(
|
336
|
+
T.any(
|
337
|
+
Orb::Price::Unit,
|
338
|
+
Orb::Price::Package,
|
339
|
+
Orb::Price::Matrix,
|
340
|
+
Orb::Price::Tiered,
|
341
|
+
Orb::Price::TieredBps,
|
342
|
+
Orb::Price::Bps,
|
343
|
+
Orb::Price::BulkBps,
|
344
|
+
Orb::Price::Bulk,
|
345
|
+
Orb::Price::ThresholdTotalAmount,
|
346
|
+
Orb::Price::TieredPackage,
|
347
|
+
Orb::Price::GroupedTiered,
|
348
|
+
Orb::Price::TieredWithMinimum,
|
349
|
+
Orb::Price::TieredPackageWithMinimum,
|
350
|
+
Orb::Price::PackageWithAllocation,
|
351
|
+
Orb::Price::UnitWithPercent,
|
352
|
+
Orb::Price::MatrixWithAllocation,
|
353
|
+
Orb::Price::TieredWithProration,
|
354
|
+
Orb::Price::UnitWithProration,
|
355
|
+
Orb::Price::GroupedAllocation,
|
356
|
+
Orb::Price::GroupedWithProratedMinimum,
|
357
|
+
Orb::Price::GroupedWithMeteredMinimum,
|
358
|
+
Orb::Price::MatrixWithDisplayName,
|
359
|
+
Orb::Price::BulkWithProration,
|
360
|
+
Orb::Price::GroupedTieredPackage,
|
361
|
+
Orb::Price::MaxGroupTieredPackage,
|
362
|
+
Orb::Price::ScalableMatrixWithUnitPricing,
|
363
|
+
Orb::Price::ScalableMatrixWithTieredPricing,
|
364
|
+
Orb::Price::CumulativeGroupedBulk
|
348
365
|
)
|
366
|
+
)
|
367
|
+
end
|
368
|
+
def fetch(price_id, request_options: {})
|
349
369
|
end
|
350
|
-
def fetch(price_id, request_options: {}); end
|
351
370
|
|
352
371
|
# @api private
|
353
372
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
354
|
-
def self.new(client:)
|
373
|
+
def self.new(client:)
|
374
|
+
end
|
355
375
|
end
|
356
376
|
end
|
357
377
|
end
|
@@ -13,10 +13,13 @@ module Orb
|
|
13
13
|
# ...). The subscription change will be referenced by the
|
14
14
|
# `pending_subscription_change` field in the response.
|
15
15
|
sig do
|
16
|
-
params(
|
17
|
-
|
16
|
+
params(
|
17
|
+
subscription_change_id: String,
|
18
|
+
request_options: Orb::RequestOptions::OrHash
|
19
|
+
).returns(Orb::Models::SubscriptionChangeRetrieveResponse)
|
20
|
+
end
|
21
|
+
def retrieve(subscription_change_id, request_options: {})
|
18
22
|
end
|
19
|
-
def retrieve(subscription_change_id, request_options: {}); end
|
20
23
|
|
21
24
|
# Apply a subscription change to perform the intended action. If a positive amount
|
22
25
|
# is passed with a request to this endpoint, any eligible invoices that were
|
@@ -26,9 +29,8 @@ module Orb
|
|
26
29
|
subscription_change_id: String,
|
27
30
|
description: T.nilable(String),
|
28
31
|
previously_collected_amount: T.nilable(String),
|
29
|
-
request_options: Orb::
|
30
|
-
)
|
31
|
-
.returns(Orb::Models::SubscriptionChangeApplyResponse)
|
32
|
+
request_options: Orb::RequestOptions::OrHash
|
33
|
+
).returns(Orb::Models::SubscriptionChangeApplyResponse)
|
32
34
|
end
|
33
35
|
def apply(
|
34
36
|
subscription_change_id,
|
@@ -37,19 +39,25 @@ module Orb
|
|
37
39
|
# Amount already collected to apply to the customer's balance.
|
38
40
|
previously_collected_amount: nil,
|
39
41
|
request_options: {}
|
40
|
-
)
|
42
|
+
)
|
43
|
+
end
|
44
|
+
|
41
45
|
# Cancel a subscription change. The change can no longer be applied. A
|
42
46
|
# subscription can only have one "pending" change at a time - use this endpoint to
|
43
47
|
# cancel an existing change before creating a new one.
|
44
48
|
sig do
|
45
|
-
params(
|
46
|
-
|
49
|
+
params(
|
50
|
+
subscription_change_id: String,
|
51
|
+
request_options: Orb::RequestOptions::OrHash
|
52
|
+
).returns(Orb::Models::SubscriptionChangeCancelResponse)
|
53
|
+
end
|
54
|
+
def cancel(subscription_change_id, request_options: {})
|
47
55
|
end
|
48
|
-
def cancel(subscription_change_id, request_options: {}); end
|
49
56
|
|
50
57
|
# @api private
|
51
58
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
52
|
-
def self.new(client:)
|
59
|
+
def self.new(client:)
|
60
|
+
end
|
53
61
|
end
|
54
62
|
end
|
55
63
|
end
|