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
@@ -10,8 +10,8 @@ module Orb
|
|
10
10
|
# @!attribute cadence
|
11
11
|
# The cadence to bill for this price on.
|
12
12
|
#
|
13
|
-
# @return [Symbol, Orb::
|
14
|
-
required :cadence, enum: -> { Orb::
|
13
|
+
# @return [Symbol, Orb::PriceCreateParams::Cadence]
|
14
|
+
required :cadence, enum: -> { Orb::PriceCreateParams::Cadence }
|
15
15
|
|
16
16
|
# @!attribute currency
|
17
17
|
# An ISO 4217 currency string for which this price is billed in.
|
@@ -27,8 +27,8 @@ module Orb
|
|
27
27
|
|
28
28
|
# @!attribute model_type
|
29
29
|
#
|
30
|
-
# @return [Symbol, Orb::
|
31
|
-
required :model_type, enum: -> { Orb::
|
30
|
+
# @return [Symbol, Orb::PriceCreateParams::ModelType]
|
31
|
+
required :model_type, enum: -> { Orb::PriceCreateParams::ModelType }
|
32
32
|
|
33
33
|
# @!attribute name
|
34
34
|
# The name of the price.
|
@@ -38,8 +38,8 @@ module Orb
|
|
38
38
|
|
39
39
|
# @!attribute unit_config
|
40
40
|
#
|
41
|
-
# @return [Orb::
|
42
|
-
required :unit_config, -> { Orb::
|
41
|
+
# @return [Orb::PriceCreateParams::UnitConfig]
|
42
|
+
required :unit_config, -> { Orb::PriceCreateParams::UnitConfig }
|
43
43
|
|
44
44
|
# @!attribute billable_metric_id
|
45
45
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -59,9 +59,9 @@ module Orb
|
|
59
59
|
# For custom cadence: specifies the duration of the billing period in days or
|
60
60
|
# months.
|
61
61
|
#
|
62
|
-
# @return [Orb::
|
62
|
+
# @return [Orb::PriceCreateParams::BillingCycleConfiguration, nil]
|
63
63
|
optional :billing_cycle_configuration,
|
64
|
-
-> { Orb::
|
64
|
+
-> { Orb::PriceCreateParams::BillingCycleConfiguration },
|
65
65
|
nil?: true
|
66
66
|
|
67
67
|
# @!attribute conversion_rate
|
@@ -93,9 +93,9 @@ module Orb
|
|
93
93
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
94
94
|
# If unspecified, a single invoice is produced per billing cycle.
|
95
95
|
#
|
96
|
-
# @return [Orb::
|
96
|
+
# @return [Orb::PriceCreateParams::InvoicingCycleConfiguration, nil]
|
97
97
|
optional :invoicing_cycle_configuration,
|
98
|
-
-> { Orb::
|
98
|
+
-> { Orb::PriceCreateParams::InvoicingCycleConfiguration },
|
99
99
|
nil?: true
|
100
100
|
|
101
101
|
# @!attribute metadata
|
@@ -108,43 +108,43 @@ module Orb
|
|
108
108
|
|
109
109
|
# @!attribute package_config
|
110
110
|
#
|
111
|
-
# @return [Orb::
|
112
|
-
required :package_config, -> { Orb::
|
111
|
+
# @return [Orb::PriceCreateParams::PackageConfig]
|
112
|
+
required :package_config, -> { Orb::PriceCreateParams::PackageConfig }
|
113
113
|
|
114
114
|
# @!attribute matrix_config
|
115
115
|
#
|
116
|
-
# @return [Orb::
|
117
|
-
required :matrix_config, -> { Orb::
|
116
|
+
# @return [Orb::PriceCreateParams::MatrixConfig]
|
117
|
+
required :matrix_config, -> { Orb::PriceCreateParams::MatrixConfig }
|
118
118
|
|
119
119
|
# @!attribute matrix_with_allocation_config
|
120
120
|
#
|
121
|
-
# @return [Orb::
|
122
|
-
required :matrix_with_allocation_config, -> { Orb::
|
121
|
+
# @return [Orb::PriceCreateParams::MatrixWithAllocationConfig]
|
122
|
+
required :matrix_with_allocation_config, -> { Orb::PriceCreateParams::MatrixWithAllocationConfig }
|
123
123
|
|
124
124
|
# @!attribute tiered_config
|
125
125
|
#
|
126
|
-
# @return [Orb::
|
127
|
-
required :tiered_config, -> { Orb::
|
126
|
+
# @return [Orb::PriceCreateParams::TieredConfig]
|
127
|
+
required :tiered_config, -> { Orb::PriceCreateParams::TieredConfig }
|
128
128
|
|
129
129
|
# @!attribute tiered_bps_config
|
130
130
|
#
|
131
|
-
# @return [Orb::
|
132
|
-
required :tiered_bps_config, -> { Orb::
|
131
|
+
# @return [Orb::PriceCreateParams::TieredBpsConfig]
|
132
|
+
required :tiered_bps_config, -> { Orb::PriceCreateParams::TieredBpsConfig }
|
133
133
|
|
134
134
|
# @!attribute bps_config
|
135
135
|
#
|
136
|
-
# @return [Orb::
|
137
|
-
required :bps_config, -> { Orb::
|
136
|
+
# @return [Orb::PriceCreateParams::BpsConfig]
|
137
|
+
required :bps_config, -> { Orb::PriceCreateParams::BpsConfig }
|
138
138
|
|
139
139
|
# @!attribute bulk_bps_config
|
140
140
|
#
|
141
|
-
# @return [Orb::
|
142
|
-
required :bulk_bps_config, -> { Orb::
|
141
|
+
# @return [Orb::PriceCreateParams::BulkBpsConfig]
|
142
|
+
required :bulk_bps_config, -> { Orb::PriceCreateParams::BulkBpsConfig }
|
143
143
|
|
144
144
|
# @!attribute bulk_config
|
145
145
|
#
|
146
|
-
# @return [Orb::
|
147
|
-
required :bulk_config, -> { Orb::
|
146
|
+
# @return [Orb::PriceCreateParams::BulkConfig]
|
147
|
+
required :bulk_config, -> { Orb::PriceCreateParams::BulkConfig }
|
148
148
|
|
149
149
|
# @!attribute threshold_total_amount_config
|
150
150
|
#
|
@@ -248,33 +248,33 @@ module Orb
|
|
248
248
|
# Some parameter documentations has been truncated, see
|
249
249
|
# {Orb::Models::PriceCreateParams} for more details.
|
250
250
|
#
|
251
|
-
# @param cadence [Symbol, Orb::
|
251
|
+
# @param cadence [Symbol, Orb::PriceCreateParams::Cadence] The cadence to bill for this price on.
|
252
252
|
#
|
253
253
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
254
254
|
#
|
255
255
|
# @param item_id [String] The id of the item the price will be associated with.
|
256
256
|
#
|
257
|
-
# @param model_type [Symbol, Orb::
|
257
|
+
# @param model_type [Symbol, Orb::PriceCreateParams::ModelType]
|
258
258
|
#
|
259
259
|
# @param name [String] The name of the price.
|
260
260
|
#
|
261
|
-
# @param unit_config [Orb::
|
261
|
+
# @param unit_config [Orb::PriceCreateParams::UnitConfig]
|
262
262
|
#
|
263
|
-
# @param package_config [Orb::
|
263
|
+
# @param package_config [Orb::PriceCreateParams::PackageConfig]
|
264
264
|
#
|
265
|
-
# @param matrix_config [Orb::
|
265
|
+
# @param matrix_config [Orb::PriceCreateParams::MatrixConfig]
|
266
266
|
#
|
267
|
-
# @param matrix_with_allocation_config [Orb::
|
267
|
+
# @param matrix_with_allocation_config [Orb::PriceCreateParams::MatrixWithAllocationConfig]
|
268
268
|
#
|
269
|
-
# @param tiered_config [Orb::
|
269
|
+
# @param tiered_config [Orb::PriceCreateParams::TieredConfig]
|
270
270
|
#
|
271
|
-
# @param tiered_bps_config [Orb::
|
271
|
+
# @param tiered_bps_config [Orb::PriceCreateParams::TieredBpsConfig]
|
272
272
|
#
|
273
|
-
# @param bps_config [Orb::
|
273
|
+
# @param bps_config [Orb::PriceCreateParams::BpsConfig]
|
274
274
|
#
|
275
|
-
# @param bulk_bps_config [Orb::
|
275
|
+
# @param bulk_bps_config [Orb::PriceCreateParams::BulkBpsConfig]
|
276
276
|
#
|
277
|
-
# @param bulk_config [Orb::
|
277
|
+
# @param bulk_config [Orb::PriceCreateParams::BulkConfig]
|
278
278
|
#
|
279
279
|
# @param threshold_total_amount_config [Hash{Symbol=>Object}]
|
280
280
|
#
|
@@ -315,28 +315,22 @@ module Orb
|
|
315
315
|
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
316
316
|
#
|
317
317
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
318
|
-
# ...
|
319
318
|
#
|
320
319
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
321
|
-
# ...
|
322
320
|
#
|
323
|
-
# @param billing_cycle_configuration [Orb::
|
324
|
-
# ...
|
321
|
+
# @param billing_cycle_configuration [Orb::PriceCreateParams::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
325
322
|
#
|
326
323
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
327
324
|
#
|
328
325
|
# @param external_price_id [String, nil] An alias for the price.
|
329
326
|
#
|
330
327
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
331
|
-
# ...
|
332
328
|
#
|
333
329
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
334
330
|
#
|
335
|
-
# @param invoicing_cycle_configuration [Orb::
|
336
|
-
# ...
|
331
|
+
# @param invoicing_cycle_configuration [Orb::PriceCreateParams::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
337
332
|
#
|
338
333
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
339
|
-
# ...
|
340
334
|
#
|
341
335
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
342
336
|
|
@@ -385,9 +379,8 @@ module Orb
|
|
385
379
|
# @!attribute duration_unit
|
386
380
|
# The unit of billing period duration.
|
387
381
|
#
|
388
|
-
# @return [Symbol, Orb::
|
389
|
-
required :duration_unit,
|
390
|
-
enum: -> { Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit }
|
382
|
+
# @return [Symbol, Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit]
|
383
|
+
required :duration_unit, enum: -> { Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit }
|
391
384
|
|
392
385
|
# @!method initialize(duration:, duration_unit:)
|
393
386
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -395,11 +388,11 @@ module Orb
|
|
395
388
|
#
|
396
389
|
# @param duration [Integer] The duration of the billing period.
|
397
390
|
#
|
398
|
-
# @param duration_unit [Symbol, Orb::
|
391
|
+
# @param duration_unit [Symbol, Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
399
392
|
|
400
393
|
# The unit of billing period duration.
|
401
394
|
#
|
402
|
-
# @see Orb::
|
395
|
+
# @see Orb::PriceCreateParams::BillingCycleConfiguration#duration_unit
|
403
396
|
module DurationUnit
|
404
397
|
extend Orb::Internal::Type::Enum
|
405
398
|
|
@@ -421,9 +414,11 @@ module Orb
|
|
421
414
|
# @!attribute duration_unit
|
422
415
|
# The unit of billing period duration.
|
423
416
|
#
|
424
|
-
# @return [Symbol, Orb::
|
417
|
+
# @return [Symbol, Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit]
|
425
418
|
required :duration_unit,
|
426
|
-
enum: -> {
|
419
|
+
enum: -> {
|
420
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit
|
421
|
+
}
|
427
422
|
|
428
423
|
# @!method initialize(duration:, duration_unit:)
|
429
424
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -431,11 +426,11 @@ module Orb
|
|
431
426
|
#
|
432
427
|
# @param duration [Integer] The duration of the billing period.
|
433
428
|
#
|
434
|
-
# @param duration_unit [Symbol, Orb::
|
429
|
+
# @param duration_unit [Symbol, Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
435
430
|
|
436
431
|
# The unit of billing period duration.
|
437
432
|
#
|
438
|
-
# @see Orb::
|
433
|
+
# @see Orb::PriceCreateParams::InvoicingCycleConfiguration#duration_unit
|
439
434
|
module DurationUnit
|
440
435
|
extend Orb::Internal::Type::Enum
|
441
436
|
|
@@ -463,12 +458,11 @@ module Orb
|
|
463
458
|
|
464
459
|
# @!method initialize(package_amount:, package_size:)
|
465
460
|
# Some parameter documentations has been truncated, see
|
466
|
-
# {Orb::
|
461
|
+
# {Orb::PriceCreateParams::PackageConfig} for more details.
|
467
462
|
#
|
468
463
|
# @param package_amount [String] A currency amount to rate usage by
|
469
464
|
#
|
470
465
|
# @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
|
471
|
-
# ...
|
472
466
|
end
|
473
467
|
|
474
468
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
@@ -487,16 +481,16 @@ module Orb
|
|
487
481
|
# @!attribute matrix_values
|
488
482
|
# Matrix values for specified matrix grouping keys
|
489
483
|
#
|
490
|
-
# @return [Array<Orb::
|
484
|
+
# @return [Array<Orb::PriceCreateParams::MatrixConfig::MatrixValue>]
|
491
485
|
required :matrix_values,
|
492
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::
|
486
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::MatrixConfig::MatrixValue] }
|
493
487
|
|
494
488
|
# @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
|
495
489
|
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
496
490
|
#
|
497
491
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
498
492
|
#
|
499
|
-
# @param matrix_values [Array<Orb::
|
493
|
+
# @param matrix_values [Array<Orb::PriceCreateParams::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
500
494
|
|
501
495
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
502
496
|
# @!attribute dimension_values
|
@@ -515,10 +509,9 @@ module Orb
|
|
515
509
|
|
516
510
|
# @!method initialize(dimension_values:, unit_amount:)
|
517
511
|
# Some parameter documentations has been truncated, see
|
518
|
-
# {Orb::
|
512
|
+
# {Orb::PriceCreateParams::MatrixConfig::MatrixValue} for more details.
|
519
513
|
#
|
520
514
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
521
|
-
# ...
|
522
515
|
#
|
523
516
|
# @param unit_amount [String] Unit price for the specified dimension_values
|
524
517
|
end
|
@@ -546,9 +539,11 @@ module Orb
|
|
546
539
|
# @!attribute matrix_values
|
547
540
|
# Matrix values for specified matrix grouping keys
|
548
541
|
#
|
549
|
-
# @return [Array<Orb::
|
542
|
+
# @return [Array<Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue>]
|
550
543
|
required :matrix_values,
|
551
|
-
-> {
|
544
|
+
-> {
|
545
|
+
Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue]
|
546
|
+
}
|
552
547
|
|
553
548
|
# @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:)
|
554
549
|
# @param allocation [Float] Allocation to be used to calculate the price
|
@@ -557,7 +552,7 @@ module Orb
|
|
557
552
|
#
|
558
553
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
559
554
|
#
|
560
|
-
# @param matrix_values [Array<Orb::
|
555
|
+
# @param matrix_values [Array<Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
561
556
|
|
562
557
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
563
558
|
# @!attribute dimension_values
|
@@ -576,11 +571,10 @@ module Orb
|
|
576
571
|
|
577
572
|
# @!method initialize(dimension_values:, unit_amount:)
|
578
573
|
# Some parameter documentations has been truncated, see
|
579
|
-
# {Orb::
|
580
|
-
#
|
574
|
+
# {Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue} for more
|
575
|
+
# details.
|
581
576
|
#
|
582
577
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
583
|
-
# ...
|
584
578
|
#
|
585
579
|
# @param unit_amount [String] Unit price for the specified dimension_values
|
586
580
|
end
|
@@ -590,11 +584,11 @@ module Orb
|
|
590
584
|
# @!attribute tiers
|
591
585
|
# Tiers for rating based on total usage quantities into the specified tier
|
592
586
|
#
|
593
|
-
# @return [Array<Orb::
|
594
|
-
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::
|
587
|
+
# @return [Array<Orb::PriceCreateParams::TieredConfig::Tier>]
|
588
|
+
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::TieredConfig::Tier] }
|
595
589
|
|
596
590
|
# @!method initialize(tiers:)
|
597
|
-
# @param tiers [Array<Orb::
|
591
|
+
# @param tiers [Array<Orb::PriceCreateParams::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
598
592
|
|
599
593
|
class Tier < Orb::Internal::Type::BaseModel
|
600
594
|
# @!attribute first_unit
|
@@ -629,16 +623,14 @@ module Orb
|
|
629
623
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
630
624
|
# tiers
|
631
625
|
#
|
632
|
-
# @return [Array<Orb::
|
633
|
-
required :tiers,
|
634
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier] }
|
626
|
+
# @return [Array<Orb::PriceCreateParams::TieredBpsConfig::Tier>]
|
627
|
+
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::TieredBpsConfig::Tier] }
|
635
628
|
|
636
629
|
# @!method initialize(tiers:)
|
637
630
|
# Some parameter documentations has been truncated, see
|
638
|
-
# {Orb::
|
631
|
+
# {Orb::PriceCreateParams::TieredBpsConfig} for more details.
|
639
632
|
#
|
640
|
-
# @param tiers [Array<Orb::
|
641
|
-
# ...
|
633
|
+
# @param tiers [Array<Orb::PriceCreateParams::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
642
634
|
|
643
635
|
class Tier < Orb::Internal::Type::BaseModel
|
644
636
|
# @!attribute bps
|
@@ -700,15 +692,14 @@ module Orb
|
|
700
692
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
701
693
|
# tier based on total volume
|
702
694
|
#
|
703
|
-
# @return [Array<Orb::
|
704
|
-
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::
|
695
|
+
# @return [Array<Orb::PriceCreateParams::BulkBpsConfig::Tier>]
|
696
|
+
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::BulkBpsConfig::Tier] }
|
705
697
|
|
706
698
|
# @!method initialize(tiers:)
|
707
699
|
# Some parameter documentations has been truncated, see
|
708
|
-
# {Orb::
|
700
|
+
# {Orb::PriceCreateParams::BulkBpsConfig} for more details.
|
709
701
|
#
|
710
|
-
# @param tiers [Array<Orb::
|
711
|
-
# ...
|
702
|
+
# @param tiers [Array<Orb::PriceCreateParams::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
712
703
|
|
713
704
|
class Tier < Orb::Internal::Type::BaseModel
|
714
705
|
# @!attribute bps
|
@@ -742,11 +733,11 @@ module Orb
|
|
742
733
|
# @!attribute tiers
|
743
734
|
# Bulk tiers for rating based on total usage volume
|
744
735
|
#
|
745
|
-
# @return [Array<Orb::
|
746
|
-
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::
|
736
|
+
# @return [Array<Orb::PriceCreateParams::BulkConfig::Tier>]
|
737
|
+
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::PriceCreateParams::BulkConfig::Tier] }
|
747
738
|
|
748
739
|
# @!method initialize(tiers:)
|
749
|
-
# @param tiers [Array<Orb::
|
740
|
+
# @param tiers [Array<Orb::PriceCreateParams::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
750
741
|
|
751
742
|
class Tier < Orb::Internal::Type::BaseModel
|
752
743
|
# @!attribute unit_amount
|
@@ -60,10 +60,8 @@ module Orb
|
|
60
60
|
# @param external_customer_id [String, nil] The external customer ID of the customer to which this evaluation is scoped.
|
61
61
|
#
|
62
62
|
# @param filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
|
63
|
-
# ...
|
64
63
|
#
|
65
64
|
# @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr
|
66
|
-
# ...
|
67
65
|
#
|
68
66
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
69
67
|
end
|
@@ -6,11 +6,11 @@ module Orb
|
|
6
6
|
class PriceEvaluateResponse < Orb::Internal::Type::BaseModel
|
7
7
|
# @!attribute data
|
8
8
|
#
|
9
|
-
# @return [Array<Orb::
|
10
|
-
required :data, -> { Orb::Internal::Type::ArrayOf[Orb::
|
9
|
+
# @return [Array<Orb::EvaluatePriceGroup>]
|
10
|
+
required :data, -> { Orb::Internal::Type::ArrayOf[Orb::EvaluatePriceGroup] }
|
11
11
|
|
12
12
|
# @!method initialize(data:)
|
13
|
-
# @param data [Array<Orb::
|
13
|
+
# @param data [Array<Orb::EvaluatePriceGroup>]
|
14
14
|
end
|
15
15
|
end
|
16
16
|
end
|
@@ -25,7 +25,6 @@ module Orb
|
|
25
25
|
# {Orb::Models::PriceListParams} for more details.
|
26
26
|
#
|
27
27
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
28
|
-
# ...
|
29
28
|
#
|
30
29
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
31
30
|
#
|
@@ -20,7 +20,6 @@ module Orb
|
|
20
20
|
# {Orb::Models::PriceUpdateParams} for more details.
|
21
21
|
#
|
22
22
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
23
|
-
# ...
|
24
23
|
#
|
25
24
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
26
25
|
end
|
@@ -21,7 +21,6 @@ module Orb
|
|
21
21
|
# {Orb::Models::Prices::ExternalPriceIDUpdateParams} for more details.
|
22
22
|
#
|
23
23
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
24
|
-
# ...
|
25
24
|
#
|
26
25
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
27
26
|
end
|