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
@@ -6,8 +6,10 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
10
|
+
|
9
11
|
# The cadence to bill for this price on.
|
10
|
-
sig { returns(Orb::
|
12
|
+
sig { returns(Orb::PriceCreateParams::Cadence::OrSymbol) }
|
11
13
|
attr_accessor :cadence
|
12
14
|
|
13
15
|
# An ISO 4217 currency string for which this price is billed in.
|
@@ -18,17 +20,19 @@ module Orb
|
|
18
20
|
sig { returns(String) }
|
19
21
|
attr_accessor :item_id
|
20
22
|
|
21
|
-
sig { returns(Orb::
|
23
|
+
sig { returns(Orb::PriceCreateParams::ModelType::OrSymbol) }
|
22
24
|
attr_accessor :model_type
|
23
25
|
|
24
26
|
# The name of the price.
|
25
27
|
sig { returns(String) }
|
26
28
|
attr_accessor :name
|
27
29
|
|
28
|
-
sig { returns(Orb::
|
30
|
+
sig { returns(Orb::PriceCreateParams::UnitConfig) }
|
29
31
|
attr_reader :unit_config
|
30
32
|
|
31
|
-
sig
|
33
|
+
sig do
|
34
|
+
params(unit_config: Orb::PriceCreateParams::UnitConfig::OrHash).void
|
35
|
+
end
|
32
36
|
attr_writer :unit_config
|
33
37
|
|
34
38
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -43,14 +47,16 @@ module Orb
|
|
43
47
|
|
44
48
|
# For custom cadence: specifies the duration of the billing period in days or
|
45
49
|
# months.
|
46
|
-
sig
|
50
|
+
sig do
|
51
|
+
returns(T.nilable(Orb::PriceCreateParams::BillingCycleConfiguration))
|
52
|
+
end
|
47
53
|
attr_reader :billing_cycle_configuration
|
48
54
|
|
49
55
|
sig do
|
50
56
|
params(
|
51
|
-
billing_cycle_configuration:
|
52
|
-
|
53
|
-
|
57
|
+
billing_cycle_configuration:
|
58
|
+
T.nilable(Orb::PriceCreateParams::BillingCycleConfiguration::OrHash)
|
59
|
+
).void
|
54
60
|
end
|
55
61
|
attr_writer :billing_cycle_configuration
|
56
62
|
|
@@ -73,14 +79,18 @@ module Orb
|
|
73
79
|
|
74
80
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
75
81
|
# If unspecified, a single invoice is produced per billing cycle.
|
76
|
-
sig
|
82
|
+
sig do
|
83
|
+
returns(T.nilable(Orb::PriceCreateParams::InvoicingCycleConfiguration))
|
84
|
+
end
|
77
85
|
attr_reader :invoicing_cycle_configuration
|
78
86
|
|
79
87
|
sig do
|
80
88
|
params(
|
81
|
-
invoicing_cycle_configuration:
|
82
|
-
|
83
|
-
|
89
|
+
invoicing_cycle_configuration:
|
90
|
+
T.nilable(
|
91
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::OrHash
|
92
|
+
)
|
93
|
+
).void
|
84
94
|
end
|
85
95
|
attr_writer :invoicing_cycle_configuration
|
86
96
|
|
@@ -90,60 +100,75 @@ module Orb
|
|
90
100
|
sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
|
91
101
|
attr_accessor :metadata
|
92
102
|
|
93
|
-
sig { returns(Orb::
|
103
|
+
sig { returns(Orb::PriceCreateParams::PackageConfig) }
|
94
104
|
attr_reader :package_config
|
95
105
|
|
96
|
-
sig
|
106
|
+
sig do
|
107
|
+
params(
|
108
|
+
package_config: Orb::PriceCreateParams::PackageConfig::OrHash
|
109
|
+
).void
|
110
|
+
end
|
97
111
|
attr_writer :package_config
|
98
112
|
|
99
|
-
sig { returns(Orb::
|
113
|
+
sig { returns(Orb::PriceCreateParams::MatrixConfig) }
|
100
114
|
attr_reader :matrix_config
|
101
115
|
|
102
|
-
sig
|
116
|
+
sig do
|
117
|
+
params(matrix_config: Orb::PriceCreateParams::MatrixConfig::OrHash).void
|
118
|
+
end
|
103
119
|
attr_writer :matrix_config
|
104
120
|
|
105
|
-
sig { returns(Orb::
|
121
|
+
sig { returns(Orb::PriceCreateParams::MatrixWithAllocationConfig) }
|
106
122
|
attr_reader :matrix_with_allocation_config
|
107
123
|
|
108
124
|
sig do
|
109
125
|
params(
|
110
|
-
matrix_with_allocation_config:
|
111
|
-
|
112
|
-
|
126
|
+
matrix_with_allocation_config:
|
127
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::OrHash
|
128
|
+
).void
|
113
129
|
end
|
114
130
|
attr_writer :matrix_with_allocation_config
|
115
131
|
|
116
|
-
sig { returns(Orb::
|
132
|
+
sig { returns(Orb::PriceCreateParams::TieredConfig) }
|
117
133
|
attr_reader :tiered_config
|
118
134
|
|
119
|
-
sig
|
135
|
+
sig do
|
136
|
+
params(tiered_config: Orb::PriceCreateParams::TieredConfig::OrHash).void
|
137
|
+
end
|
120
138
|
attr_writer :tiered_config
|
121
139
|
|
122
|
-
sig { returns(Orb::
|
140
|
+
sig { returns(Orb::PriceCreateParams::TieredBpsConfig) }
|
123
141
|
attr_reader :tiered_bps_config
|
124
142
|
|
125
143
|
sig do
|
126
|
-
params(
|
127
|
-
|
144
|
+
params(
|
145
|
+
tiered_bps_config: Orb::PriceCreateParams::TieredBpsConfig::OrHash
|
146
|
+
).void
|
128
147
|
end
|
129
148
|
attr_writer :tiered_bps_config
|
130
149
|
|
131
|
-
sig { returns(Orb::
|
150
|
+
sig { returns(Orb::PriceCreateParams::BpsConfig) }
|
132
151
|
attr_reader :bps_config
|
133
152
|
|
134
|
-
sig { params(bps_config:
|
153
|
+
sig { params(bps_config: Orb::PriceCreateParams::BpsConfig::OrHash).void }
|
135
154
|
attr_writer :bps_config
|
136
155
|
|
137
|
-
sig { returns(Orb::
|
156
|
+
sig { returns(Orb::PriceCreateParams::BulkBpsConfig) }
|
138
157
|
attr_reader :bulk_bps_config
|
139
158
|
|
140
|
-
sig
|
159
|
+
sig do
|
160
|
+
params(
|
161
|
+
bulk_bps_config: Orb::PriceCreateParams::BulkBpsConfig::OrHash
|
162
|
+
).void
|
163
|
+
end
|
141
164
|
attr_writer :bulk_bps_config
|
142
165
|
|
143
|
-
sig { returns(Orb::
|
166
|
+
sig { returns(Orb::PriceCreateParams::BulkConfig) }
|
144
167
|
attr_reader :bulk_config
|
145
168
|
|
146
|
-
sig
|
169
|
+
sig do
|
170
|
+
params(bulk_config: Orb::PriceCreateParams::BulkConfig::OrHash).void
|
171
|
+
end
|
147
172
|
attr_writer :bulk_config
|
148
173
|
|
149
174
|
sig { returns(T::Hash[Symbol, T.anything]) }
|
@@ -205,20 +230,21 @@ module Orb
|
|
205
230
|
|
206
231
|
sig do
|
207
232
|
params(
|
208
|
-
cadence: Orb::
|
233
|
+
cadence: Orb::PriceCreateParams::Cadence::OrSymbol,
|
209
234
|
currency: String,
|
210
235
|
item_id: String,
|
211
|
-
model_type: Orb::
|
236
|
+
model_type: Orb::PriceCreateParams::ModelType::OrSymbol,
|
212
237
|
name: String,
|
213
|
-
unit_config:
|
214
|
-
package_config:
|
215
|
-
matrix_config:
|
216
|
-
matrix_with_allocation_config:
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
238
|
+
unit_config: Orb::PriceCreateParams::UnitConfig::OrHash,
|
239
|
+
package_config: Orb::PriceCreateParams::PackageConfig::OrHash,
|
240
|
+
matrix_config: Orb::PriceCreateParams::MatrixConfig::OrHash,
|
241
|
+
matrix_with_allocation_config:
|
242
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::OrHash,
|
243
|
+
tiered_config: Orb::PriceCreateParams::TieredConfig::OrHash,
|
244
|
+
tiered_bps_config: Orb::PriceCreateParams::TieredBpsConfig::OrHash,
|
245
|
+
bps_config: Orb::PriceCreateParams::BpsConfig::OrHash,
|
246
|
+
bulk_bps_config: Orb::PriceCreateParams::BulkBpsConfig::OrHash,
|
247
|
+
bulk_config: Orb::PriceCreateParams::BulkConfig::OrHash,
|
222
248
|
threshold_total_amount_config: T::Hash[Symbol, T.anything],
|
223
249
|
tiered_package_config: T::Hash[Symbol, T.anything],
|
224
250
|
grouped_tiered_config: T::Hash[Symbol, T.anything],
|
@@ -236,20 +262,26 @@ module Orb
|
|
236
262
|
bulk_with_proration_config: T::Hash[Symbol, T.anything],
|
237
263
|
grouped_tiered_package_config: T::Hash[Symbol, T.anything],
|
238
264
|
scalable_matrix_with_unit_pricing_config: T::Hash[Symbol, T.anything],
|
239
|
-
scalable_matrix_with_tiered_pricing_config:
|
265
|
+
scalable_matrix_with_tiered_pricing_config:
|
266
|
+
T::Hash[Symbol, T.anything],
|
240
267
|
cumulative_grouped_bulk_config: T::Hash[Symbol, T.anything],
|
241
268
|
billable_metric_id: T.nilable(String),
|
242
269
|
billed_in_advance: T.nilable(T::Boolean),
|
243
|
-
billing_cycle_configuration:
|
270
|
+
billing_cycle_configuration:
|
271
|
+
T.nilable(
|
272
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::OrHash
|
273
|
+
),
|
244
274
|
conversion_rate: T.nilable(Float),
|
245
275
|
external_price_id: T.nilable(String),
|
246
276
|
fixed_price_quantity: T.nilable(Float),
|
247
277
|
invoice_grouping_key: T.nilable(String),
|
248
|
-
invoicing_cycle_configuration:
|
278
|
+
invoicing_cycle_configuration:
|
279
|
+
T.nilable(
|
280
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::OrHash
|
281
|
+
),
|
249
282
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
250
|
-
request_options:
|
251
|
-
)
|
252
|
-
.returns(T.attached_class)
|
283
|
+
request_options: Orb::RequestOptions::OrHash
|
284
|
+
).returns(T.attached_class)
|
253
285
|
end
|
254
286
|
def self.new(
|
255
287
|
# The cadence to bill for this price on.
|
@@ -315,91 +347,118 @@ module Orb
|
|
315
347
|
# by setting `metadata` to `null`.
|
316
348
|
metadata: nil,
|
317
349
|
request_options: {}
|
318
|
-
)
|
350
|
+
)
|
351
|
+
end
|
352
|
+
|
319
353
|
sig do
|
320
|
-
override
|
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
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
354
|
+
override.returns(
|
355
|
+
{
|
356
|
+
cadence: Orb::PriceCreateParams::Cadence::OrSymbol,
|
357
|
+
currency: String,
|
358
|
+
item_id: String,
|
359
|
+
model_type: Orb::PriceCreateParams::ModelType::OrSymbol,
|
360
|
+
name: String,
|
361
|
+
unit_config: Orb::PriceCreateParams::UnitConfig,
|
362
|
+
billable_metric_id: T.nilable(String),
|
363
|
+
billed_in_advance: T.nilable(T::Boolean),
|
364
|
+
billing_cycle_configuration:
|
365
|
+
T.nilable(Orb::PriceCreateParams::BillingCycleConfiguration),
|
366
|
+
conversion_rate: T.nilable(Float),
|
367
|
+
external_price_id: T.nilable(String),
|
368
|
+
fixed_price_quantity: T.nilable(Float),
|
369
|
+
invoice_grouping_key: T.nilable(String),
|
370
|
+
invoicing_cycle_configuration:
|
371
|
+
T.nilable(Orb::PriceCreateParams::InvoicingCycleConfiguration),
|
372
|
+
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
373
|
+
package_config: Orb::PriceCreateParams::PackageConfig,
|
374
|
+
matrix_config: Orb::PriceCreateParams::MatrixConfig,
|
375
|
+
matrix_with_allocation_config:
|
376
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig,
|
377
|
+
tiered_config: Orb::PriceCreateParams::TieredConfig,
|
378
|
+
tiered_bps_config: Orb::PriceCreateParams::TieredBpsConfig,
|
379
|
+
bps_config: Orb::PriceCreateParams::BpsConfig,
|
380
|
+
bulk_bps_config: Orb::PriceCreateParams::BulkBpsConfig,
|
381
|
+
bulk_config: Orb::PriceCreateParams::BulkConfig,
|
382
|
+
threshold_total_amount_config: T::Hash[Symbol, T.anything],
|
383
|
+
tiered_package_config: T::Hash[Symbol, T.anything],
|
384
|
+
grouped_tiered_config: T::Hash[Symbol, T.anything],
|
385
|
+
max_group_tiered_package_config: T::Hash[Symbol, T.anything],
|
386
|
+
tiered_with_minimum_config: T::Hash[Symbol, T.anything],
|
387
|
+
package_with_allocation_config: T::Hash[Symbol, T.anything],
|
388
|
+
tiered_package_with_minimum_config: T::Hash[Symbol, T.anything],
|
389
|
+
unit_with_percent_config: T::Hash[Symbol, T.anything],
|
390
|
+
tiered_with_proration_config: T::Hash[Symbol, T.anything],
|
391
|
+
unit_with_proration_config: T::Hash[Symbol, T.anything],
|
392
|
+
grouped_allocation_config: T::Hash[Symbol, T.anything],
|
393
|
+
grouped_with_prorated_minimum_config: T::Hash[Symbol, T.anything],
|
394
|
+
grouped_with_metered_minimum_config: T::Hash[Symbol, T.anything],
|
395
|
+
matrix_with_display_name_config: T::Hash[Symbol, T.anything],
|
396
|
+
bulk_with_proration_config: T::Hash[Symbol, T.anything],
|
397
|
+
grouped_tiered_package_config: T::Hash[Symbol, T.anything],
|
398
|
+
scalable_matrix_with_unit_pricing_config:
|
399
|
+
T::Hash[Symbol, T.anything],
|
400
|
+
scalable_matrix_with_tiered_pricing_config:
|
401
|
+
T::Hash[Symbol, T.anything],
|
402
|
+
cumulative_grouped_bulk_config: T::Hash[Symbol, T.anything],
|
403
|
+
request_options: Orb::RequestOptions
|
404
|
+
}
|
405
|
+
)
|
406
|
+
end
|
407
|
+
def to_hash
|
368
408
|
end
|
369
|
-
def to_hash; end
|
370
409
|
|
371
410
|
# The cadence to bill for this price on.
|
372
411
|
module Cadence
|
373
412
|
extend Orb::Internal::Type::Enum
|
374
413
|
|
375
|
-
TaggedSymbol =
|
414
|
+
TaggedSymbol =
|
415
|
+
T.type_alias { T.all(Symbol, Orb::PriceCreateParams::Cadence) }
|
376
416
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
377
417
|
|
378
|
-
ANNUAL = T.let(:annual, Orb::
|
379
|
-
SEMI_ANNUAL =
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
418
|
+
ANNUAL = T.let(:annual, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
419
|
+
SEMI_ANNUAL =
|
420
|
+
T.let(:semi_annual, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
421
|
+
MONTHLY = T.let(:monthly, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
422
|
+
QUARTERLY =
|
423
|
+
T.let(:quarterly, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
424
|
+
ONE_TIME =
|
425
|
+
T.let(:one_time, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
426
|
+
CUSTOM = T.let(:custom, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
384
427
|
|
385
|
-
sig
|
386
|
-
|
428
|
+
sig do
|
429
|
+
override.returns(
|
430
|
+
T::Array[Orb::PriceCreateParams::Cadence::TaggedSymbol]
|
431
|
+
)
|
432
|
+
end
|
433
|
+
def self.values
|
434
|
+
end
|
387
435
|
end
|
388
436
|
|
389
437
|
module ModelType
|
390
438
|
extend Orb::Internal::Type::Enum
|
391
439
|
|
392
|
-
TaggedSymbol =
|
440
|
+
TaggedSymbol =
|
441
|
+
T.type_alias { T.all(Symbol, Orb::PriceCreateParams::ModelType) }
|
393
442
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
394
443
|
|
395
444
|
CUMULATIVE_GROUPED_BULK =
|
396
|
-
T.let(
|
445
|
+
T.let(
|
446
|
+
:cumulative_grouped_bulk,
|
447
|
+
Orb::PriceCreateParams::ModelType::TaggedSymbol
|
448
|
+
)
|
397
449
|
|
398
|
-
sig
|
399
|
-
|
450
|
+
sig do
|
451
|
+
override.returns(
|
452
|
+
T::Array[Orb::PriceCreateParams::ModelType::TaggedSymbol]
|
453
|
+
)
|
454
|
+
end
|
455
|
+
def self.values
|
456
|
+
end
|
400
457
|
end
|
401
458
|
|
402
459
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
460
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
461
|
+
|
403
462
|
# Rate per unit of usage
|
404
463
|
sig { returns(String) }
|
405
464
|
attr_accessor :unit_amount
|
@@ -408,18 +467,27 @@ module Orb
|
|
408
467
|
def self.new(
|
409
468
|
# Rate per unit of usage
|
410
469
|
unit_amount:
|
411
|
-
)
|
412
|
-
|
413
|
-
|
470
|
+
)
|
471
|
+
end
|
472
|
+
|
473
|
+
sig { override.returns({ unit_amount: String }) }
|
474
|
+
def to_hash
|
475
|
+
end
|
414
476
|
end
|
415
477
|
|
416
478
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
479
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
480
|
+
|
417
481
|
# The duration of the billing period.
|
418
482
|
sig { returns(Integer) }
|
419
483
|
attr_accessor :duration
|
420
484
|
|
421
485
|
# The unit of billing period duration.
|
422
|
-
sig
|
486
|
+
sig do
|
487
|
+
returns(
|
488
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::OrSymbol
|
489
|
+
)
|
490
|
+
end
|
423
491
|
attr_accessor :duration_unit
|
424
492
|
|
425
493
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -427,54 +495,79 @@ module Orb
|
|
427
495
|
sig do
|
428
496
|
params(
|
429
497
|
duration: Integer,
|
430
|
-
duration_unit:
|
431
|
-
|
432
|
-
|
498
|
+
duration_unit:
|
499
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::OrSymbol
|
500
|
+
).returns(T.attached_class)
|
433
501
|
end
|
434
502
|
def self.new(
|
435
503
|
# The duration of the billing period.
|
436
504
|
duration:,
|
437
505
|
# The unit of billing period duration.
|
438
506
|
duration_unit:
|
439
|
-
)
|
507
|
+
)
|
508
|
+
end
|
509
|
+
|
440
510
|
sig do
|
441
|
-
override
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
511
|
+
override.returns(
|
512
|
+
{
|
513
|
+
duration: Integer,
|
514
|
+
duration_unit:
|
515
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::OrSymbol
|
516
|
+
}
|
517
|
+
)
|
518
|
+
end
|
519
|
+
def to_hash
|
448
520
|
end
|
449
|
-
def to_hash; end
|
450
521
|
|
451
522
|
# The unit of billing period duration.
|
452
523
|
module DurationUnit
|
453
524
|
extend Orb::Internal::Type::Enum
|
454
525
|
|
455
526
|
TaggedSymbol =
|
456
|
-
T.type_alias
|
527
|
+
T.type_alias do
|
528
|
+
T.all(
|
529
|
+
Symbol,
|
530
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit
|
531
|
+
)
|
532
|
+
end
|
457
533
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
458
534
|
|
459
|
-
DAY =
|
535
|
+
DAY =
|
536
|
+
T.let(
|
537
|
+
:day,
|
538
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
539
|
+
)
|
460
540
|
MONTH =
|
461
|
-
T.let(
|
541
|
+
T.let(
|
542
|
+
:month,
|
543
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
544
|
+
)
|
462
545
|
|
463
546
|
sig do
|
464
|
-
override
|
465
|
-
|
547
|
+
override.returns(
|
548
|
+
T::Array[
|
549
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
550
|
+
]
|
551
|
+
)
|
552
|
+
end
|
553
|
+
def self.values
|
466
554
|
end
|
467
|
-
def self.values; end
|
468
555
|
end
|
469
556
|
end
|
470
557
|
|
471
558
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
559
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
560
|
+
|
472
561
|
# The duration of the billing period.
|
473
562
|
sig { returns(Integer) }
|
474
563
|
attr_accessor :duration
|
475
564
|
|
476
565
|
# The unit of billing period duration.
|
477
|
-
sig
|
566
|
+
sig do
|
567
|
+
returns(
|
568
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::OrSymbol
|
569
|
+
)
|
570
|
+
end
|
478
571
|
attr_accessor :duration_unit
|
479
572
|
|
480
573
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -482,49 +575,69 @@ module Orb
|
|
482
575
|
sig do
|
483
576
|
params(
|
484
577
|
duration: Integer,
|
485
|
-
duration_unit:
|
486
|
-
|
487
|
-
|
578
|
+
duration_unit:
|
579
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::OrSymbol
|
580
|
+
).returns(T.attached_class)
|
488
581
|
end
|
489
582
|
def self.new(
|
490
583
|
# The duration of the billing period.
|
491
584
|
duration:,
|
492
585
|
# The unit of billing period duration.
|
493
586
|
duration_unit:
|
494
|
-
)
|
587
|
+
)
|
588
|
+
end
|
589
|
+
|
495
590
|
sig do
|
496
|
-
override
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
591
|
+
override.returns(
|
592
|
+
{
|
593
|
+
duration: Integer,
|
594
|
+
duration_unit:
|
595
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::OrSymbol
|
596
|
+
}
|
597
|
+
)
|
598
|
+
end
|
599
|
+
def to_hash
|
503
600
|
end
|
504
|
-
def to_hash; end
|
505
601
|
|
506
602
|
# The unit of billing period duration.
|
507
603
|
module DurationUnit
|
508
604
|
extend Orb::Internal::Type::Enum
|
509
605
|
|
510
606
|
TaggedSymbol =
|
511
|
-
T.type_alias
|
607
|
+
T.type_alias do
|
608
|
+
T.all(
|
609
|
+
Symbol,
|
610
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit
|
611
|
+
)
|
612
|
+
end
|
512
613
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
513
614
|
|
514
615
|
DAY =
|
515
|
-
T.let(
|
616
|
+
T.let(
|
617
|
+
:day,
|
618
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
619
|
+
)
|
516
620
|
MONTH =
|
517
|
-
T.let(
|
621
|
+
T.let(
|
622
|
+
:month,
|
623
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
624
|
+
)
|
518
625
|
|
519
626
|
sig do
|
520
|
-
override
|
521
|
-
|
627
|
+
override.returns(
|
628
|
+
T::Array[
|
629
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
630
|
+
]
|
631
|
+
)
|
632
|
+
end
|
633
|
+
def self.values
|
522
634
|
end
|
523
|
-
def self.values; end
|
524
635
|
end
|
525
636
|
end
|
526
637
|
|
527
638
|
class PackageConfig < Orb::Internal::Type::BaseModel
|
639
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
640
|
+
|
528
641
|
# A currency amount to rate usage by
|
529
642
|
sig { returns(String) }
|
530
643
|
attr_accessor :package_amount
|
@@ -534,19 +647,30 @@ module Orb
|
|
534
647
|
sig { returns(Integer) }
|
535
648
|
attr_accessor :package_size
|
536
649
|
|
537
|
-
sig
|
650
|
+
sig do
|
651
|
+
params(package_amount: String, package_size: Integer).returns(
|
652
|
+
T.attached_class
|
653
|
+
)
|
654
|
+
end
|
538
655
|
def self.new(
|
539
656
|
# A currency amount to rate usage by
|
540
657
|
package_amount:,
|
541
658
|
# An integer amount to represent package size. For example, 1000 here would divide
|
542
659
|
# usage by 1000 before multiplying by package_amount in rating
|
543
660
|
package_size:
|
544
|
-
)
|
545
|
-
|
546
|
-
|
661
|
+
)
|
662
|
+
end
|
663
|
+
|
664
|
+
sig do
|
665
|
+
override.returns({ package_amount: String, package_size: Integer })
|
666
|
+
end
|
667
|
+
def to_hash
|
668
|
+
end
|
547
669
|
end
|
548
670
|
|
549
671
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
672
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
673
|
+
|
550
674
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
551
675
|
sig { returns(String) }
|
552
676
|
attr_accessor :default_unit_amount
|
@@ -556,16 +680,20 @@ module Orb
|
|
556
680
|
attr_accessor :dimensions
|
557
681
|
|
558
682
|
# Matrix values for specified matrix grouping keys
|
559
|
-
sig
|
683
|
+
sig do
|
684
|
+
returns(T::Array[Orb::PriceCreateParams::MatrixConfig::MatrixValue])
|
685
|
+
end
|
560
686
|
attr_accessor :matrix_values
|
561
687
|
|
562
688
|
sig do
|
563
689
|
params(
|
564
690
|
default_unit_amount: String,
|
565
691
|
dimensions: T::Array[T.nilable(String)],
|
566
|
-
matrix_values:
|
567
|
-
|
568
|
-
|
692
|
+
matrix_values:
|
693
|
+
T::Array[
|
694
|
+
Orb::PriceCreateParams::MatrixConfig::MatrixValue::OrHash
|
695
|
+
]
|
696
|
+
).returns(T.attached_class)
|
569
697
|
end
|
570
698
|
def self.new(
|
571
699
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
@@ -574,20 +702,25 @@ module Orb
|
|
574
702
|
dimensions:,
|
575
703
|
# Matrix values for specified matrix grouping keys
|
576
704
|
matrix_values:
|
577
|
-
)
|
705
|
+
)
|
706
|
+
end
|
707
|
+
|
578
708
|
sig do
|
579
|
-
override
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
709
|
+
override.returns(
|
710
|
+
{
|
711
|
+
default_unit_amount: String,
|
712
|
+
dimensions: T::Array[T.nilable(String)],
|
713
|
+
matrix_values:
|
714
|
+
T::Array[Orb::PriceCreateParams::MatrixConfig::MatrixValue]
|
715
|
+
}
|
716
|
+
)
|
717
|
+
end
|
718
|
+
def to_hash
|
587
719
|
end
|
588
|
-
def to_hash; end
|
589
720
|
|
590
721
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
722
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
723
|
+
|
591
724
|
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
592
725
|
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
593
726
|
# instance tier.
|
@@ -611,13 +744,25 @@ module Orb
|
|
611
744
|
dimension_values:,
|
612
745
|
# Unit price for the specified dimension_values
|
613
746
|
unit_amount:
|
614
|
-
)
|
615
|
-
|
616
|
-
|
747
|
+
)
|
748
|
+
end
|
749
|
+
|
750
|
+
sig do
|
751
|
+
override.returns(
|
752
|
+
{
|
753
|
+
dimension_values: T::Array[T.nilable(String)],
|
754
|
+
unit_amount: String
|
755
|
+
}
|
756
|
+
)
|
757
|
+
end
|
758
|
+
def to_hash
|
759
|
+
end
|
617
760
|
end
|
618
761
|
end
|
619
762
|
|
620
763
|
class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
|
764
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
765
|
+
|
621
766
|
# Allocation to be used to calculate the price
|
622
767
|
sig { returns(Float) }
|
623
768
|
attr_accessor :allocation
|
@@ -631,7 +776,13 @@ module Orb
|
|
631
776
|
attr_accessor :dimensions
|
632
777
|
|
633
778
|
# Matrix values for specified matrix grouping keys
|
634
|
-
sig
|
779
|
+
sig do
|
780
|
+
returns(
|
781
|
+
T::Array[
|
782
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue
|
783
|
+
]
|
784
|
+
)
|
785
|
+
end
|
635
786
|
attr_accessor :matrix_values
|
636
787
|
|
637
788
|
sig do
|
@@ -639,9 +790,11 @@ module Orb
|
|
639
790
|
allocation: Float,
|
640
791
|
default_unit_amount: String,
|
641
792
|
dimensions: T::Array[T.nilable(String)],
|
642
|
-
matrix_values:
|
643
|
-
|
644
|
-
|
793
|
+
matrix_values:
|
794
|
+
T::Array[
|
795
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue::OrHash
|
796
|
+
]
|
797
|
+
).returns(T.attached_class)
|
645
798
|
end
|
646
799
|
def self.new(
|
647
800
|
# Allocation to be used to calculate the price
|
@@ -652,21 +805,28 @@ module Orb
|
|
652
805
|
dimensions:,
|
653
806
|
# Matrix values for specified matrix grouping keys
|
654
807
|
matrix_values:
|
655
|
-
)
|
808
|
+
)
|
809
|
+
end
|
810
|
+
|
656
811
|
sig do
|
657
|
-
override
|
658
|
-
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
812
|
+
override.returns(
|
813
|
+
{
|
814
|
+
allocation: Float,
|
815
|
+
default_unit_amount: String,
|
816
|
+
dimensions: T::Array[T.nilable(String)],
|
817
|
+
matrix_values:
|
818
|
+
T::Array[
|
819
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue
|
820
|
+
]
|
821
|
+
}
|
822
|
+
)
|
823
|
+
end
|
824
|
+
def to_hash
|
666
825
|
end
|
667
|
-
def to_hash; end
|
668
826
|
|
669
827
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
828
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
829
|
+
|
670
830
|
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
671
831
|
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
672
832
|
# instance tier.
|
@@ -690,29 +850,51 @@ module Orb
|
|
690
850
|
dimension_values:,
|
691
851
|
# Unit price for the specified dimension_values
|
692
852
|
unit_amount:
|
693
|
-
)
|
694
|
-
|
695
|
-
|
853
|
+
)
|
854
|
+
end
|
855
|
+
|
856
|
+
sig do
|
857
|
+
override.returns(
|
858
|
+
{
|
859
|
+
dimension_values: T::Array[T.nilable(String)],
|
860
|
+
unit_amount: String
|
861
|
+
}
|
862
|
+
)
|
863
|
+
end
|
864
|
+
def to_hash
|
865
|
+
end
|
696
866
|
end
|
697
867
|
end
|
698
868
|
|
699
869
|
class TieredConfig < Orb::Internal::Type::BaseModel
|
870
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
871
|
+
|
700
872
|
# Tiers for rating based on total usage quantities into the specified tier
|
701
|
-
sig { returns(T::Array[Orb::
|
873
|
+
sig { returns(T::Array[Orb::PriceCreateParams::TieredConfig::Tier]) }
|
702
874
|
attr_accessor :tiers
|
703
875
|
|
704
876
|
sig do
|
705
|
-
params(
|
706
|
-
|
877
|
+
params(
|
878
|
+
tiers: T::Array[Orb::PriceCreateParams::TieredConfig::Tier::OrHash]
|
879
|
+
).returns(T.attached_class)
|
707
880
|
end
|
708
881
|
def self.new(
|
709
882
|
# Tiers for rating based on total usage quantities into the specified tier
|
710
883
|
tiers:
|
711
|
-
)
|
712
|
-
|
713
|
-
|
884
|
+
)
|
885
|
+
end
|
886
|
+
|
887
|
+
sig do
|
888
|
+
override.returns(
|
889
|
+
{ tiers: T::Array[Orb::PriceCreateParams::TieredConfig::Tier] }
|
890
|
+
)
|
891
|
+
end
|
892
|
+
def to_hash
|
893
|
+
end
|
714
894
|
|
715
895
|
class Tier < Orb::Internal::Type::BaseModel
|
896
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
897
|
+
|
716
898
|
# Exclusive tier starting value
|
717
899
|
sig { returns(Float) }
|
718
900
|
attr_accessor :first_unit
|
@@ -739,33 +921,55 @@ module Orb
|
|
739
921
|
unit_amount:,
|
740
922
|
# Inclusive tier ending value. If null, this is treated as the last tier
|
741
923
|
last_unit: nil
|
742
|
-
)
|
743
|
-
|
744
|
-
|
924
|
+
)
|
925
|
+
end
|
926
|
+
|
927
|
+
sig do
|
928
|
+
override.returns(
|
929
|
+
{
|
930
|
+
first_unit: Float,
|
931
|
+
unit_amount: String,
|
932
|
+
last_unit: T.nilable(Float)
|
933
|
+
}
|
934
|
+
)
|
935
|
+
end
|
936
|
+
def to_hash
|
937
|
+
end
|
745
938
|
end
|
746
939
|
end
|
747
940
|
|
748
941
|
class TieredBpsConfig < Orb::Internal::Type::BaseModel
|
942
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
943
|
+
|
749
944
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
750
945
|
# tiers
|
751
|
-
sig { returns(T::Array[Orb::
|
946
|
+
sig { returns(T::Array[Orb::PriceCreateParams::TieredBpsConfig::Tier]) }
|
752
947
|
attr_accessor :tiers
|
753
948
|
|
754
949
|
sig do
|
755
950
|
params(
|
756
|
-
tiers:
|
757
|
-
|
758
|
-
|
951
|
+
tiers:
|
952
|
+
T::Array[Orb::PriceCreateParams::TieredBpsConfig::Tier::OrHash]
|
953
|
+
).returns(T.attached_class)
|
759
954
|
end
|
760
955
|
def self.new(
|
761
956
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
762
957
|
# tiers
|
763
958
|
tiers:
|
764
|
-
)
|
765
|
-
|
766
|
-
|
959
|
+
)
|
960
|
+
end
|
961
|
+
|
962
|
+
sig do
|
963
|
+
override.returns(
|
964
|
+
{ tiers: T::Array[Orb::PriceCreateParams::TieredBpsConfig::Tier] }
|
965
|
+
)
|
966
|
+
end
|
967
|
+
def to_hash
|
968
|
+
end
|
767
969
|
|
768
970
|
class Tier < Orb::Internal::Type::BaseModel
|
971
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
972
|
+
|
769
973
|
# Per-event basis point rate
|
770
974
|
sig { returns(Float) }
|
771
975
|
attr_accessor :bps
|
@@ -788,8 +992,7 @@ module Orb
|
|
788
992
|
minimum_amount: String,
|
789
993
|
maximum_amount: T.nilable(String),
|
790
994
|
per_unit_maximum: T.nilable(String)
|
791
|
-
)
|
792
|
-
.returns(T.attached_class)
|
995
|
+
).returns(T.attached_class)
|
793
996
|
end
|
794
997
|
def self.new(
|
795
998
|
# Per-event basis point rate
|
@@ -800,23 +1003,27 @@ module Orb
|
|
800
1003
|
maximum_amount: nil,
|
801
1004
|
# Per unit maximum to charge
|
802
1005
|
per_unit_maximum: nil
|
803
|
-
)
|
1006
|
+
)
|
1007
|
+
end
|
1008
|
+
|
804
1009
|
sig do
|
805
|
-
override
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
1010
|
+
override.returns(
|
1011
|
+
{
|
1012
|
+
bps: Float,
|
1013
|
+
minimum_amount: String,
|
1014
|
+
maximum_amount: T.nilable(String),
|
1015
|
+
per_unit_maximum: T.nilable(String)
|
1016
|
+
}
|
1017
|
+
)
|
1018
|
+
end
|
1019
|
+
def to_hash
|
814
1020
|
end
|
815
|
-
def to_hash; end
|
816
1021
|
end
|
817
1022
|
end
|
818
1023
|
|
819
1024
|
class BpsConfig < Orb::Internal::Type::BaseModel
|
1025
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1026
|
+
|
820
1027
|
# Basis point take rate per event
|
821
1028
|
sig { returns(Float) }
|
822
1029
|
attr_accessor :bps
|
@@ -825,38 +1032,57 @@ module Orb
|
|
825
1032
|
sig { returns(T.nilable(String)) }
|
826
1033
|
attr_accessor :per_unit_maximum
|
827
1034
|
|
828
|
-
sig
|
1035
|
+
sig do
|
1036
|
+
params(bps: Float, per_unit_maximum: T.nilable(String)).returns(
|
1037
|
+
T.attached_class
|
1038
|
+
)
|
1039
|
+
end
|
829
1040
|
def self.new(
|
830
1041
|
# Basis point take rate per event
|
831
1042
|
bps:,
|
832
1043
|
# Optional currency amount maximum to cap spend per event
|
833
1044
|
per_unit_maximum: nil
|
834
|
-
)
|
835
|
-
|
836
|
-
|
1045
|
+
)
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
sig do
|
1049
|
+
override.returns({ bps: Float, per_unit_maximum: T.nilable(String) })
|
1050
|
+
end
|
1051
|
+
def to_hash
|
1052
|
+
end
|
837
1053
|
end
|
838
1054
|
|
839
1055
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
1056
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1057
|
+
|
840
1058
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
841
1059
|
# tier based on total volume
|
842
|
-
sig { returns(T::Array[Orb::
|
1060
|
+
sig { returns(T::Array[Orb::PriceCreateParams::BulkBpsConfig::Tier]) }
|
843
1061
|
attr_accessor :tiers
|
844
1062
|
|
845
1063
|
sig do
|
846
1064
|
params(
|
847
|
-
tiers: T::Array[
|
848
|
-
)
|
849
|
-
.returns(T.attached_class)
|
1065
|
+
tiers: T::Array[Orb::PriceCreateParams::BulkBpsConfig::Tier::OrHash]
|
1066
|
+
).returns(T.attached_class)
|
850
1067
|
end
|
851
1068
|
def self.new(
|
852
1069
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
853
1070
|
# tier based on total volume
|
854
1071
|
tiers:
|
855
|
-
)
|
856
|
-
|
857
|
-
|
1072
|
+
)
|
1073
|
+
end
|
1074
|
+
|
1075
|
+
sig do
|
1076
|
+
override.returns(
|
1077
|
+
{ tiers: T::Array[Orb::PriceCreateParams::BulkBpsConfig::Tier] }
|
1078
|
+
)
|
1079
|
+
end
|
1080
|
+
def to_hash
|
1081
|
+
end
|
858
1082
|
|
859
1083
|
class Tier < Orb::Internal::Type::BaseModel
|
1084
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1085
|
+
|
860
1086
|
# Basis points to rate on
|
861
1087
|
sig { returns(Float) }
|
862
1088
|
attr_accessor :bps
|
@@ -870,8 +1096,11 @@ module Orb
|
|
870
1096
|
attr_accessor :per_unit_maximum
|
871
1097
|
|
872
1098
|
sig do
|
873
|
-
params(
|
874
|
-
|
1099
|
+
params(
|
1100
|
+
bps: Float,
|
1101
|
+
maximum_amount: T.nilable(String),
|
1102
|
+
per_unit_maximum: T.nilable(String)
|
1103
|
+
).returns(T.attached_class)
|
875
1104
|
end
|
876
1105
|
def self.new(
|
877
1106
|
# Basis points to rate on
|
@@ -880,7 +1109,9 @@ module Orb
|
|
880
1109
|
maximum_amount: nil,
|
881
1110
|
# The maximum amount to charge for any one event
|
882
1111
|
per_unit_maximum: nil
|
883
|
-
)
|
1112
|
+
)
|
1113
|
+
end
|
1114
|
+
|
884
1115
|
sig do
|
885
1116
|
override.returns(
|
886
1117
|
{
|
@@ -890,27 +1121,40 @@ module Orb
|
|
890
1121
|
}
|
891
1122
|
)
|
892
1123
|
end
|
893
|
-
def to_hash
|
1124
|
+
def to_hash
|
1125
|
+
end
|
894
1126
|
end
|
895
1127
|
end
|
896
1128
|
|
897
1129
|
class BulkConfig < Orb::Internal::Type::BaseModel
|
1130
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1131
|
+
|
898
1132
|
# Bulk tiers for rating based on total usage volume
|
899
|
-
sig { returns(T::Array[Orb::
|
1133
|
+
sig { returns(T::Array[Orb::PriceCreateParams::BulkConfig::Tier]) }
|
900
1134
|
attr_accessor :tiers
|
901
1135
|
|
902
1136
|
sig do
|
903
|
-
params(
|
904
|
-
|
1137
|
+
params(
|
1138
|
+
tiers: T::Array[Orb::PriceCreateParams::BulkConfig::Tier::OrHash]
|
1139
|
+
).returns(T.attached_class)
|
905
1140
|
end
|
906
1141
|
def self.new(
|
907
1142
|
# Bulk tiers for rating based on total usage volume
|
908
1143
|
tiers:
|
909
|
-
)
|
910
|
-
|
911
|
-
|
1144
|
+
)
|
1145
|
+
end
|
1146
|
+
|
1147
|
+
sig do
|
1148
|
+
override.returns(
|
1149
|
+
{ tiers: T::Array[Orb::PriceCreateParams::BulkConfig::Tier] }
|
1150
|
+
)
|
1151
|
+
end
|
1152
|
+
def to_hash
|
1153
|
+
end
|
912
1154
|
|
913
1155
|
class Tier < Orb::Internal::Type::BaseModel
|
1156
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
1157
|
+
|
914
1158
|
# Amount per unit
|
915
1159
|
sig { returns(String) }
|
916
1160
|
attr_accessor :unit_amount
|
@@ -919,15 +1163,27 @@ module Orb
|
|
919
1163
|
sig { returns(T.nilable(Float)) }
|
920
1164
|
attr_accessor :maximum_units
|
921
1165
|
|
922
|
-
sig
|
1166
|
+
sig do
|
1167
|
+
params(
|
1168
|
+
unit_amount: String,
|
1169
|
+
maximum_units: T.nilable(Float)
|
1170
|
+
).returns(T.attached_class)
|
1171
|
+
end
|
923
1172
|
def self.new(
|
924
1173
|
# Amount per unit
|
925
1174
|
unit_amount:,
|
926
1175
|
# Upper bound for this tier
|
927
1176
|
maximum_units: nil
|
928
|
-
)
|
929
|
-
|
930
|
-
|
1177
|
+
)
|
1178
|
+
end
|
1179
|
+
|
1180
|
+
sig do
|
1181
|
+
override.returns(
|
1182
|
+
{ unit_amount: String, maximum_units: T.nilable(Float) }
|
1183
|
+
)
|
1184
|
+
end
|
1185
|
+
def to_hash
|
1186
|
+
end
|
931
1187
|
end
|
932
1188
|
end
|
933
1189
|
end
|