orb-billing 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +3 -3
- data/lib/orb/errors.rb +1 -1
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/transport/base_client.rb +74 -5
- data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
- data/lib/orb/internal/type/array_of.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +62 -30
- data/lib/orb/internal/type/converter.rb +18 -0
- data/lib/orb/internal/type/enum.rb +4 -3
- data/lib/orb/internal/type/hash_of.rb +1 -1
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +5 -4
- data/lib/orb/internal/util.rb +57 -1
- data/lib/orb/internal.rb +6 -0
- 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 +13 -12
- data/lib/orb/models/coupon_create_params.rb +12 -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 +50 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
- data/lib/orb/models/customer_update_params.rb +50 -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 +14 -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 +14 -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 +14 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -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 +11 -5
- data/lib/orb/models/evaluate_price_group.rb +5 -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 +179 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +8 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +28 -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 +90 -103
- data/lib/orb/models/plan_create_params.rb +759 -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 +1706 -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 +108 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +43 -57
- data/lib/orb/models/subscription_change_apply_response.rb +43 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
- data/lib/orb/models/subscription_create_params.rb +1953 -1815
- data/lib/orb/models/subscription_create_response.rb +43 -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 +1194 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -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 +43 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +8 -6
- data/lib/orb/models/subscription_update_trial_response.rb +43 -57
- data/lib/orb/models/subscription_usage.rb +55 -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/models.rb +24 -0
- data/lib/orb/request_options.rb +4 -0
- 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 +3 -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 +20 -6
- data/rbi/orb/internal/transport/base_client.rbi +159 -78
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +144 -69
- data/rbi/orb/internal/type/base_page.rbi +12 -8
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +68 -31
- data/rbi/orb/internal/type/enum.rbi +28 -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 +61 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +232 -90
- data/rbi/orb/internal.rbi +2 -0
- data/rbi/orb/models/alert.rbi +114 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
- data/rbi/orb/models/alert_disable_params.rbi +18 -6
- data/rbi/orb/models/alert_enable_params.rbi +18 -6
- data/rbi/orb/models/alert_list_params.rbi +24 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
- data/rbi/orb/models/alert_update_params.rbi +29 -14
- data/rbi/orb/models/amount_discount.rbi +29 -19
- data/rbi/orb/models/billable_metric.rbi +34 -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 +11 -4
- data/rbi/orb/models/coupon_create_params.rbi +85 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
- data/rbi/orb/models/coupon_list_params.rbi +19 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
- data/rbi/orb/models/credit_note.rbi +329 -158
- data/rbi/orb/models/credit_note_create_params.rbi +64 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
- data/rbi/orb/models/credit_note_list_params.rbi +23 -17
- data/rbi/orb/models/customer.rbi +461 -329
- data/rbi/orb/models/customer_create_params.rbi +713 -325
- data/rbi/orb/models/customer_delete_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
- data/rbi/orb/models/customer_fetch_params.rbi +11 -4
- data/rbi/orb/models/customer_list_params.rbi +21 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
- data/rbi/orb/models/customer_update_params.rbi +712 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
- data/rbi/orb/models/dimensional_price_group.rbi +21 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
- data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +29 -12
- data/rbi/orb/models/event_deprecate_params.rbi +13 -4
- data/rbi/orb/models/event_deprecate_response.rbi +11 -3
- data/rbi/orb/models/event_ingest_params.rbi +41 -31
- data/rbi/orb/models/event_ingest_response.rbi +78 -23
- data/rbi/orb/models/event_search_params.rbi +18 -14
- data/rbi/orb/models/event_search_response.rbi +42 -21
- data/rbi/orb/models/event_update_params.rbi +20 -16
- data/rbi/orb/models/event_update_response.rbi +11 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
- data/rbi/orb/models/events/event_volumes.rbi +38 -10
- data/rbi/orb/models/events/volume_list_params.rbi +21 -15
- data/rbi/orb/models/invoice.rbi +1411 -805
- data/rbi/orb/models/invoice_create_params.rbi +107 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
- data/rbi/orb/models/invoice_issue_params.rbi +17 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
- data/rbi/orb/models/invoice_list_params.rbi +68 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
- data/rbi/orb/models/invoice_pay_params.rbi +11 -4
- data/rbi/orb/models/invoice_update_params.rbi +16 -10
- data/rbi/orb/models/invoice_void_params.rbi +11 -4
- data/rbi/orb/models/item.rbi +90 -39
- data/rbi/orb/models/item_create_params.rbi +15 -5
- data/rbi/orb/models/item_fetch_params.rbi +11 -4
- data/rbi/orb/models/item_list_params.rbi +17 -6
- data/rbi/orb/models/item_update_params.rbi +86 -39
- data/rbi/orb/models/metric_create_params.rbi +20 -16
- data/rbi/orb/models/metric_fetch_params.rbi +11 -4
- data/rbi/orb/models/metric_list_params.rbi +21 -17
- data/rbi/orb/models/metric_update_params.rbi +16 -10
- data/rbi/orb/models/pagination_metadata.rbi +17 -4
- data/rbi/orb/models/percentage_discount.rbi +33 -19
- data/rbi/orb/models/plan.rbi +532 -365
- data/rbi/orb/models/plan_create_params.rbi +5295 -2870
- data/rbi/orb/models/plan_fetch_params.rbi +11 -4
- data/rbi/orb/models/plan_list_params.rbi +35 -27
- data/rbi/orb/models/plan_update_params.rbi +17 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
- data/rbi/orb/models/price.rbi +11332 -5033
- data/rbi/orb/models/price_create_params.rbi +583 -245
- data/rbi/orb/models/price_evaluate_params.rbi +21 -17
- data/rbi/orb/models/price_evaluate_response.rbi +14 -6
- data/rbi/orb/models/price_fetch_params.rbi +11 -4
- data/rbi/orb/models/price_list_params.rbi +17 -6
- data/rbi/orb/models/price_update_params.rbi +16 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
- data/rbi/orb/models/subscription.rbi +668 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
- data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
- data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
- data/rbi/orb/models/subscription_create_response.rbi +817 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
- data/rbi/orb/models/subscription_list_params.rbi +42 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
- data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
- data/rbi/orb/models/subscription_update_params.rbi +22 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
- data/rbi/orb/models/subscription_usage.rbi +325 -121
- data/rbi/orb/models/subscriptions.rbi +19 -11
- data/rbi/orb/models/top_level_ping_params.rbi +11 -4
- data/rbi/orb/models/top_level_ping_response.rbi +10 -3
- data/rbi/orb/models/trial_discount.rbi +30 -20
- data/rbi/orb/models/usage_discount.rbi +29 -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/transport/base_client.rbs +16 -1
- data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
- data/sig/orb/internal/type/base_model.rbs +11 -5
- data/sig/orb/internal/type/base_page.rbs +1 -1
- data/sig/orb/internal/type/converter.rbs +2 -0
- data/sig/orb/internal/type/enum.rbs +1 -0
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/type/union.rbs +1 -0
- data/sig/orb/internal/util.rbs +13 -0
- data/sig/orb/internal.rbs +2 -0
- 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,11 @@ module Orb
|
|
6
6
|
extend Orb::Internal::Type::RequestParameters::Converter
|
7
7
|
include Orb::Internal::Type::RequestParameters
|
8
8
|
|
9
|
+
OrHash =
|
10
|
+
T.type_alias { T.any(Orb::PriceCreateParams, Orb::Internal::AnyHash) }
|
11
|
+
|
9
12
|
# The cadence to bill for this price on.
|
10
|
-
sig { returns(Orb::
|
13
|
+
sig { returns(Orb::PriceCreateParams::Cadence::OrSymbol) }
|
11
14
|
attr_accessor :cadence
|
12
15
|
|
13
16
|
# An ISO 4217 currency string for which this price is billed in.
|
@@ -18,17 +21,19 @@ module Orb
|
|
18
21
|
sig { returns(String) }
|
19
22
|
attr_accessor :item_id
|
20
23
|
|
21
|
-
sig { returns(Orb::
|
24
|
+
sig { returns(Orb::PriceCreateParams::ModelType::OrSymbol) }
|
22
25
|
attr_accessor :model_type
|
23
26
|
|
24
27
|
# The name of the price.
|
25
28
|
sig { returns(String) }
|
26
29
|
attr_accessor :name
|
27
30
|
|
28
|
-
sig { returns(Orb::
|
31
|
+
sig { returns(Orb::PriceCreateParams::UnitConfig) }
|
29
32
|
attr_reader :unit_config
|
30
33
|
|
31
|
-
sig
|
34
|
+
sig do
|
35
|
+
params(unit_config: Orb::PriceCreateParams::UnitConfig::OrHash).void
|
36
|
+
end
|
32
37
|
attr_writer :unit_config
|
33
38
|
|
34
39
|
# The id of the billable metric for the price. Only needed if the price is
|
@@ -43,14 +48,16 @@ module Orb
|
|
43
48
|
|
44
49
|
# For custom cadence: specifies the duration of the billing period in days or
|
45
50
|
# months.
|
46
|
-
sig
|
51
|
+
sig do
|
52
|
+
returns(T.nilable(Orb::PriceCreateParams::BillingCycleConfiguration))
|
53
|
+
end
|
47
54
|
attr_reader :billing_cycle_configuration
|
48
55
|
|
49
56
|
sig do
|
50
57
|
params(
|
51
|
-
billing_cycle_configuration:
|
52
|
-
|
53
|
-
|
58
|
+
billing_cycle_configuration:
|
59
|
+
T.nilable(Orb::PriceCreateParams::BillingCycleConfiguration::OrHash)
|
60
|
+
).void
|
54
61
|
end
|
55
62
|
attr_writer :billing_cycle_configuration
|
56
63
|
|
@@ -73,14 +80,18 @@ module Orb
|
|
73
80
|
|
74
81
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
75
82
|
# If unspecified, a single invoice is produced per billing cycle.
|
76
|
-
sig
|
83
|
+
sig do
|
84
|
+
returns(T.nilable(Orb::PriceCreateParams::InvoicingCycleConfiguration))
|
85
|
+
end
|
77
86
|
attr_reader :invoicing_cycle_configuration
|
78
87
|
|
79
88
|
sig do
|
80
89
|
params(
|
81
|
-
invoicing_cycle_configuration:
|
82
|
-
|
83
|
-
|
90
|
+
invoicing_cycle_configuration:
|
91
|
+
T.nilable(
|
92
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::OrHash
|
93
|
+
)
|
94
|
+
).void
|
84
95
|
end
|
85
96
|
attr_writer :invoicing_cycle_configuration
|
86
97
|
|
@@ -90,60 +101,75 @@ module Orb
|
|
90
101
|
sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
|
91
102
|
attr_accessor :metadata
|
92
103
|
|
93
|
-
sig { returns(Orb::
|
104
|
+
sig { returns(Orb::PriceCreateParams::PackageConfig) }
|
94
105
|
attr_reader :package_config
|
95
106
|
|
96
|
-
sig
|
107
|
+
sig do
|
108
|
+
params(
|
109
|
+
package_config: Orb::PriceCreateParams::PackageConfig::OrHash
|
110
|
+
).void
|
111
|
+
end
|
97
112
|
attr_writer :package_config
|
98
113
|
|
99
|
-
sig { returns(Orb::
|
114
|
+
sig { returns(Orb::PriceCreateParams::MatrixConfig) }
|
100
115
|
attr_reader :matrix_config
|
101
116
|
|
102
|
-
sig
|
117
|
+
sig do
|
118
|
+
params(matrix_config: Orb::PriceCreateParams::MatrixConfig::OrHash).void
|
119
|
+
end
|
103
120
|
attr_writer :matrix_config
|
104
121
|
|
105
|
-
sig { returns(Orb::
|
122
|
+
sig { returns(Orb::PriceCreateParams::MatrixWithAllocationConfig) }
|
106
123
|
attr_reader :matrix_with_allocation_config
|
107
124
|
|
108
125
|
sig do
|
109
126
|
params(
|
110
|
-
matrix_with_allocation_config:
|
111
|
-
|
112
|
-
|
127
|
+
matrix_with_allocation_config:
|
128
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::OrHash
|
129
|
+
).void
|
113
130
|
end
|
114
131
|
attr_writer :matrix_with_allocation_config
|
115
132
|
|
116
|
-
sig { returns(Orb::
|
133
|
+
sig { returns(Orb::PriceCreateParams::TieredConfig) }
|
117
134
|
attr_reader :tiered_config
|
118
135
|
|
119
|
-
sig
|
136
|
+
sig do
|
137
|
+
params(tiered_config: Orb::PriceCreateParams::TieredConfig::OrHash).void
|
138
|
+
end
|
120
139
|
attr_writer :tiered_config
|
121
140
|
|
122
|
-
sig { returns(Orb::
|
141
|
+
sig { returns(Orb::PriceCreateParams::TieredBpsConfig) }
|
123
142
|
attr_reader :tiered_bps_config
|
124
143
|
|
125
144
|
sig do
|
126
|
-
params(
|
127
|
-
|
145
|
+
params(
|
146
|
+
tiered_bps_config: Orb::PriceCreateParams::TieredBpsConfig::OrHash
|
147
|
+
).void
|
128
148
|
end
|
129
149
|
attr_writer :tiered_bps_config
|
130
150
|
|
131
|
-
sig { returns(Orb::
|
151
|
+
sig { returns(Orb::PriceCreateParams::BpsConfig) }
|
132
152
|
attr_reader :bps_config
|
133
153
|
|
134
|
-
sig { params(bps_config:
|
154
|
+
sig { params(bps_config: Orb::PriceCreateParams::BpsConfig::OrHash).void }
|
135
155
|
attr_writer :bps_config
|
136
156
|
|
137
|
-
sig { returns(Orb::
|
157
|
+
sig { returns(Orb::PriceCreateParams::BulkBpsConfig) }
|
138
158
|
attr_reader :bulk_bps_config
|
139
159
|
|
140
|
-
sig
|
160
|
+
sig do
|
161
|
+
params(
|
162
|
+
bulk_bps_config: Orb::PriceCreateParams::BulkBpsConfig::OrHash
|
163
|
+
).void
|
164
|
+
end
|
141
165
|
attr_writer :bulk_bps_config
|
142
166
|
|
143
|
-
sig { returns(Orb::
|
167
|
+
sig { returns(Orb::PriceCreateParams::BulkConfig) }
|
144
168
|
attr_reader :bulk_config
|
145
169
|
|
146
|
-
sig
|
170
|
+
sig do
|
171
|
+
params(bulk_config: Orb::PriceCreateParams::BulkConfig::OrHash).void
|
172
|
+
end
|
147
173
|
attr_writer :bulk_config
|
148
174
|
|
149
175
|
sig { returns(T::Hash[Symbol, T.anything]) }
|
@@ -205,20 +231,21 @@ module Orb
|
|
205
231
|
|
206
232
|
sig do
|
207
233
|
params(
|
208
|
-
cadence: Orb::
|
234
|
+
cadence: Orb::PriceCreateParams::Cadence::OrSymbol,
|
209
235
|
currency: String,
|
210
236
|
item_id: String,
|
211
|
-
model_type: Orb::
|
237
|
+
model_type: Orb::PriceCreateParams::ModelType::OrSymbol,
|
212
238
|
name: String,
|
213
|
-
unit_config:
|
214
|
-
package_config:
|
215
|
-
matrix_config:
|
216
|
-
matrix_with_allocation_config:
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
239
|
+
unit_config: Orb::PriceCreateParams::UnitConfig::OrHash,
|
240
|
+
package_config: Orb::PriceCreateParams::PackageConfig::OrHash,
|
241
|
+
matrix_config: Orb::PriceCreateParams::MatrixConfig::OrHash,
|
242
|
+
matrix_with_allocation_config:
|
243
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::OrHash,
|
244
|
+
tiered_config: Orb::PriceCreateParams::TieredConfig::OrHash,
|
245
|
+
tiered_bps_config: Orb::PriceCreateParams::TieredBpsConfig::OrHash,
|
246
|
+
bps_config: Orb::PriceCreateParams::BpsConfig::OrHash,
|
247
|
+
bulk_bps_config: Orb::PriceCreateParams::BulkBpsConfig::OrHash,
|
248
|
+
bulk_config: Orb::PriceCreateParams::BulkConfig::OrHash,
|
222
249
|
threshold_total_amount_config: T::Hash[Symbol, T.anything],
|
223
250
|
tiered_package_config: T::Hash[Symbol, T.anything],
|
224
251
|
grouped_tiered_config: T::Hash[Symbol, T.anything],
|
@@ -236,20 +263,26 @@ module Orb
|
|
236
263
|
bulk_with_proration_config: T::Hash[Symbol, T.anything],
|
237
264
|
grouped_tiered_package_config: T::Hash[Symbol, T.anything],
|
238
265
|
scalable_matrix_with_unit_pricing_config: T::Hash[Symbol, T.anything],
|
239
|
-
scalable_matrix_with_tiered_pricing_config:
|
266
|
+
scalable_matrix_with_tiered_pricing_config:
|
267
|
+
T::Hash[Symbol, T.anything],
|
240
268
|
cumulative_grouped_bulk_config: T::Hash[Symbol, T.anything],
|
241
269
|
billable_metric_id: T.nilable(String),
|
242
270
|
billed_in_advance: T.nilable(T::Boolean),
|
243
|
-
billing_cycle_configuration:
|
271
|
+
billing_cycle_configuration:
|
272
|
+
T.nilable(
|
273
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::OrHash
|
274
|
+
),
|
244
275
|
conversion_rate: T.nilable(Float),
|
245
276
|
external_price_id: T.nilable(String),
|
246
277
|
fixed_price_quantity: T.nilable(Float),
|
247
278
|
invoice_grouping_key: T.nilable(String),
|
248
|
-
invoicing_cycle_configuration:
|
279
|
+
invoicing_cycle_configuration:
|
280
|
+
T.nilable(
|
281
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::OrHash
|
282
|
+
),
|
249
283
|
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
250
|
-
request_options:
|
251
|
-
)
|
252
|
-
.returns(T.attached_class)
|
284
|
+
request_options: Orb::RequestOptions::OrHash
|
285
|
+
).returns(T.attached_class)
|
253
286
|
end
|
254
287
|
def self.new(
|
255
288
|
# The cadence to bill for this price on.
|
@@ -315,91 +348,121 @@ module Orb
|
|
315
348
|
# by setting `metadata` to `null`.
|
316
349
|
metadata: nil,
|
317
350
|
request_options: {}
|
318
|
-
)
|
351
|
+
)
|
352
|
+
end
|
353
|
+
|
319
354
|
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
|
-
|
355
|
+
override.returns(
|
356
|
+
{
|
357
|
+
cadence: Orb::PriceCreateParams::Cadence::OrSymbol,
|
358
|
+
currency: String,
|
359
|
+
item_id: String,
|
360
|
+
model_type: Orb::PriceCreateParams::ModelType::OrSymbol,
|
361
|
+
name: String,
|
362
|
+
unit_config: Orb::PriceCreateParams::UnitConfig,
|
363
|
+
billable_metric_id: T.nilable(String),
|
364
|
+
billed_in_advance: T.nilable(T::Boolean),
|
365
|
+
billing_cycle_configuration:
|
366
|
+
T.nilable(Orb::PriceCreateParams::BillingCycleConfiguration),
|
367
|
+
conversion_rate: T.nilable(Float),
|
368
|
+
external_price_id: T.nilable(String),
|
369
|
+
fixed_price_quantity: T.nilable(Float),
|
370
|
+
invoice_grouping_key: T.nilable(String),
|
371
|
+
invoicing_cycle_configuration:
|
372
|
+
T.nilable(Orb::PriceCreateParams::InvoicingCycleConfiguration),
|
373
|
+
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
374
|
+
package_config: Orb::PriceCreateParams::PackageConfig,
|
375
|
+
matrix_config: Orb::PriceCreateParams::MatrixConfig,
|
376
|
+
matrix_with_allocation_config:
|
377
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig,
|
378
|
+
tiered_config: Orb::PriceCreateParams::TieredConfig,
|
379
|
+
tiered_bps_config: Orb::PriceCreateParams::TieredBpsConfig,
|
380
|
+
bps_config: Orb::PriceCreateParams::BpsConfig,
|
381
|
+
bulk_bps_config: Orb::PriceCreateParams::BulkBpsConfig,
|
382
|
+
bulk_config: Orb::PriceCreateParams::BulkConfig,
|
383
|
+
threshold_total_amount_config: T::Hash[Symbol, T.anything],
|
384
|
+
tiered_package_config: T::Hash[Symbol, T.anything],
|
385
|
+
grouped_tiered_config: T::Hash[Symbol, T.anything],
|
386
|
+
max_group_tiered_package_config: T::Hash[Symbol, T.anything],
|
387
|
+
tiered_with_minimum_config: T::Hash[Symbol, T.anything],
|
388
|
+
package_with_allocation_config: T::Hash[Symbol, T.anything],
|
389
|
+
tiered_package_with_minimum_config: T::Hash[Symbol, T.anything],
|
390
|
+
unit_with_percent_config: T::Hash[Symbol, T.anything],
|
391
|
+
tiered_with_proration_config: T::Hash[Symbol, T.anything],
|
392
|
+
unit_with_proration_config: T::Hash[Symbol, T.anything],
|
393
|
+
grouped_allocation_config: T::Hash[Symbol, T.anything],
|
394
|
+
grouped_with_prorated_minimum_config: T::Hash[Symbol, T.anything],
|
395
|
+
grouped_with_metered_minimum_config: T::Hash[Symbol, T.anything],
|
396
|
+
matrix_with_display_name_config: T::Hash[Symbol, T.anything],
|
397
|
+
bulk_with_proration_config: T::Hash[Symbol, T.anything],
|
398
|
+
grouped_tiered_package_config: T::Hash[Symbol, T.anything],
|
399
|
+
scalable_matrix_with_unit_pricing_config:
|
400
|
+
T::Hash[Symbol, T.anything],
|
401
|
+
scalable_matrix_with_tiered_pricing_config:
|
402
|
+
T::Hash[Symbol, T.anything],
|
403
|
+
cumulative_grouped_bulk_config: T::Hash[Symbol, T.anything],
|
404
|
+
request_options: Orb::RequestOptions
|
405
|
+
}
|
406
|
+
)
|
407
|
+
end
|
408
|
+
def to_hash
|
368
409
|
end
|
369
|
-
def to_hash; end
|
370
410
|
|
371
411
|
# The cadence to bill for this price on.
|
372
412
|
module Cadence
|
373
413
|
extend Orb::Internal::Type::Enum
|
374
414
|
|
375
|
-
TaggedSymbol =
|
415
|
+
TaggedSymbol =
|
416
|
+
T.type_alias { T.all(Symbol, Orb::PriceCreateParams::Cadence) }
|
376
417
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
377
418
|
|
378
|
-
ANNUAL = T.let(:annual, Orb::
|
379
|
-
SEMI_ANNUAL =
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
419
|
+
ANNUAL = T.let(:annual, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
420
|
+
SEMI_ANNUAL =
|
421
|
+
T.let(:semi_annual, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
422
|
+
MONTHLY = T.let(:monthly, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
423
|
+
QUARTERLY =
|
424
|
+
T.let(:quarterly, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
425
|
+
ONE_TIME =
|
426
|
+
T.let(:one_time, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
427
|
+
CUSTOM = T.let(:custom, Orb::PriceCreateParams::Cadence::TaggedSymbol)
|
384
428
|
|
385
|
-
sig
|
386
|
-
|
429
|
+
sig do
|
430
|
+
override.returns(
|
431
|
+
T::Array[Orb::PriceCreateParams::Cadence::TaggedSymbol]
|
432
|
+
)
|
433
|
+
end
|
434
|
+
def self.values
|
435
|
+
end
|
387
436
|
end
|
388
437
|
|
389
438
|
module ModelType
|
390
439
|
extend Orb::Internal::Type::Enum
|
391
440
|
|
392
|
-
TaggedSymbol =
|
441
|
+
TaggedSymbol =
|
442
|
+
T.type_alias { T.all(Symbol, Orb::PriceCreateParams::ModelType) }
|
393
443
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
394
444
|
|
395
445
|
CUMULATIVE_GROUPED_BULK =
|
396
|
-
T.let(
|
446
|
+
T.let(
|
447
|
+
:cumulative_grouped_bulk,
|
448
|
+
Orb::PriceCreateParams::ModelType::TaggedSymbol
|
449
|
+
)
|
397
450
|
|
398
|
-
sig
|
399
|
-
|
451
|
+
sig do
|
452
|
+
override.returns(
|
453
|
+
T::Array[Orb::PriceCreateParams::ModelType::TaggedSymbol]
|
454
|
+
)
|
455
|
+
end
|
456
|
+
def self.values
|
457
|
+
end
|
400
458
|
end
|
401
459
|
|
402
460
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
461
|
+
OrHash =
|
462
|
+
T.type_alias do
|
463
|
+
T.any(Orb::PriceCreateParams::UnitConfig, Orb::Internal::AnyHash)
|
464
|
+
end
|
465
|
+
|
403
466
|
# Rate per unit of usage
|
404
467
|
sig { returns(String) }
|
405
468
|
attr_accessor :unit_amount
|
@@ -408,18 +471,33 @@ module Orb
|
|
408
471
|
def self.new(
|
409
472
|
# Rate per unit of usage
|
410
473
|
unit_amount:
|
411
|
-
)
|
412
|
-
|
413
|
-
|
474
|
+
)
|
475
|
+
end
|
476
|
+
|
477
|
+
sig { override.returns({ unit_amount: String }) }
|
478
|
+
def to_hash
|
479
|
+
end
|
414
480
|
end
|
415
481
|
|
416
482
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
483
|
+
OrHash =
|
484
|
+
T.type_alias do
|
485
|
+
T.any(
|
486
|
+
Orb::PriceCreateParams::BillingCycleConfiguration,
|
487
|
+
Orb::Internal::AnyHash
|
488
|
+
)
|
489
|
+
end
|
490
|
+
|
417
491
|
# The duration of the billing period.
|
418
492
|
sig { returns(Integer) }
|
419
493
|
attr_accessor :duration
|
420
494
|
|
421
495
|
# The unit of billing period duration.
|
422
|
-
sig
|
496
|
+
sig do
|
497
|
+
returns(
|
498
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::OrSymbol
|
499
|
+
)
|
500
|
+
end
|
423
501
|
attr_accessor :duration_unit
|
424
502
|
|
425
503
|
# For custom cadence: specifies the duration of the billing period in days or
|
@@ -427,54 +505,85 @@ module Orb
|
|
427
505
|
sig do
|
428
506
|
params(
|
429
507
|
duration: Integer,
|
430
|
-
duration_unit:
|
431
|
-
|
432
|
-
|
508
|
+
duration_unit:
|
509
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::OrSymbol
|
510
|
+
).returns(T.attached_class)
|
433
511
|
end
|
434
512
|
def self.new(
|
435
513
|
# The duration of the billing period.
|
436
514
|
duration:,
|
437
515
|
# The unit of billing period duration.
|
438
516
|
duration_unit:
|
439
|
-
)
|
517
|
+
)
|
518
|
+
end
|
519
|
+
|
440
520
|
sig do
|
441
|
-
override
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
521
|
+
override.returns(
|
522
|
+
{
|
523
|
+
duration: Integer,
|
524
|
+
duration_unit:
|
525
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::OrSymbol
|
526
|
+
}
|
527
|
+
)
|
528
|
+
end
|
529
|
+
def to_hash
|
448
530
|
end
|
449
|
-
def to_hash; end
|
450
531
|
|
451
532
|
# The unit of billing period duration.
|
452
533
|
module DurationUnit
|
453
534
|
extend Orb::Internal::Type::Enum
|
454
535
|
|
455
536
|
TaggedSymbol =
|
456
|
-
T.type_alias
|
537
|
+
T.type_alias do
|
538
|
+
T.all(
|
539
|
+
Symbol,
|
540
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit
|
541
|
+
)
|
542
|
+
end
|
457
543
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
458
544
|
|
459
|
-
DAY =
|
545
|
+
DAY =
|
546
|
+
T.let(
|
547
|
+
:day,
|
548
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
549
|
+
)
|
460
550
|
MONTH =
|
461
|
-
T.let(
|
551
|
+
T.let(
|
552
|
+
:month,
|
553
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
554
|
+
)
|
462
555
|
|
463
556
|
sig do
|
464
|
-
override
|
465
|
-
|
557
|
+
override.returns(
|
558
|
+
T::Array[
|
559
|
+
Orb::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
560
|
+
]
|
561
|
+
)
|
562
|
+
end
|
563
|
+
def self.values
|
466
564
|
end
|
467
|
-
def self.values; end
|
468
565
|
end
|
469
566
|
end
|
470
567
|
|
471
568
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
569
|
+
OrHash =
|
570
|
+
T.type_alias do
|
571
|
+
T.any(
|
572
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration,
|
573
|
+
Orb::Internal::AnyHash
|
574
|
+
)
|
575
|
+
end
|
576
|
+
|
472
577
|
# The duration of the billing period.
|
473
578
|
sig { returns(Integer) }
|
474
579
|
attr_accessor :duration
|
475
580
|
|
476
581
|
# The unit of billing period duration.
|
477
|
-
sig
|
582
|
+
sig do
|
583
|
+
returns(
|
584
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::OrSymbol
|
585
|
+
)
|
586
|
+
end
|
478
587
|
attr_accessor :duration_unit
|
479
588
|
|
480
589
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
@@ -482,49 +591,72 @@ module Orb
|
|
482
591
|
sig do
|
483
592
|
params(
|
484
593
|
duration: Integer,
|
485
|
-
duration_unit:
|
486
|
-
|
487
|
-
|
594
|
+
duration_unit:
|
595
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::OrSymbol
|
596
|
+
).returns(T.attached_class)
|
488
597
|
end
|
489
598
|
def self.new(
|
490
599
|
# The duration of the billing period.
|
491
600
|
duration:,
|
492
601
|
# The unit of billing period duration.
|
493
602
|
duration_unit:
|
494
|
-
)
|
603
|
+
)
|
604
|
+
end
|
605
|
+
|
495
606
|
sig do
|
496
|
-
override
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
607
|
+
override.returns(
|
608
|
+
{
|
609
|
+
duration: Integer,
|
610
|
+
duration_unit:
|
611
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::OrSymbol
|
612
|
+
}
|
613
|
+
)
|
614
|
+
end
|
615
|
+
def to_hash
|
503
616
|
end
|
504
|
-
def to_hash; end
|
505
617
|
|
506
618
|
# The unit of billing period duration.
|
507
619
|
module DurationUnit
|
508
620
|
extend Orb::Internal::Type::Enum
|
509
621
|
|
510
622
|
TaggedSymbol =
|
511
|
-
T.type_alias
|
623
|
+
T.type_alias do
|
624
|
+
T.all(
|
625
|
+
Symbol,
|
626
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit
|
627
|
+
)
|
628
|
+
end
|
512
629
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
513
630
|
|
514
631
|
DAY =
|
515
|
-
T.let(
|
632
|
+
T.let(
|
633
|
+
:day,
|
634
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
635
|
+
)
|
516
636
|
MONTH =
|
517
|
-
T.let(
|
637
|
+
T.let(
|
638
|
+
:month,
|
639
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
640
|
+
)
|
518
641
|
|
519
642
|
sig do
|
520
|
-
override
|
521
|
-
|
643
|
+
override.returns(
|
644
|
+
T::Array[
|
645
|
+
Orb::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
646
|
+
]
|
647
|
+
)
|
648
|
+
end
|
649
|
+
def self.values
|
522
650
|
end
|
523
|
-
def self.values; end
|
524
651
|
end
|
525
652
|
end
|
526
653
|
|
527
654
|
class PackageConfig < Orb::Internal::Type::BaseModel
|
655
|
+
OrHash =
|
656
|
+
T.type_alias do
|
657
|
+
T.any(Orb::PriceCreateParams::PackageConfig, Orb::Internal::AnyHash)
|
658
|
+
end
|
659
|
+
|
528
660
|
# A currency amount to rate usage by
|
529
661
|
sig { returns(String) }
|
530
662
|
attr_accessor :package_amount
|
@@ -534,19 +666,33 @@ module Orb
|
|
534
666
|
sig { returns(Integer) }
|
535
667
|
attr_accessor :package_size
|
536
668
|
|
537
|
-
sig
|
669
|
+
sig do
|
670
|
+
params(package_amount: String, package_size: Integer).returns(
|
671
|
+
T.attached_class
|
672
|
+
)
|
673
|
+
end
|
538
674
|
def self.new(
|
539
675
|
# A currency amount to rate usage by
|
540
676
|
package_amount:,
|
541
677
|
# An integer amount to represent package size. For example, 1000 here would divide
|
542
678
|
# usage by 1000 before multiplying by package_amount in rating
|
543
679
|
package_size:
|
544
|
-
)
|
545
|
-
|
546
|
-
|
680
|
+
)
|
681
|
+
end
|
682
|
+
|
683
|
+
sig do
|
684
|
+
override.returns({ package_amount: String, package_size: Integer })
|
685
|
+
end
|
686
|
+
def to_hash
|
687
|
+
end
|
547
688
|
end
|
548
689
|
|
549
690
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
691
|
+
OrHash =
|
692
|
+
T.type_alias do
|
693
|
+
T.any(Orb::PriceCreateParams::MatrixConfig, Orb::Internal::AnyHash)
|
694
|
+
end
|
695
|
+
|
550
696
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
551
697
|
sig { returns(String) }
|
552
698
|
attr_accessor :default_unit_amount
|
@@ -556,16 +702,20 @@ module Orb
|
|
556
702
|
attr_accessor :dimensions
|
557
703
|
|
558
704
|
# Matrix values for specified matrix grouping keys
|
559
|
-
sig
|
705
|
+
sig do
|
706
|
+
returns(T::Array[Orb::PriceCreateParams::MatrixConfig::MatrixValue])
|
707
|
+
end
|
560
708
|
attr_accessor :matrix_values
|
561
709
|
|
562
710
|
sig do
|
563
711
|
params(
|
564
712
|
default_unit_amount: String,
|
565
713
|
dimensions: T::Array[T.nilable(String)],
|
566
|
-
matrix_values:
|
567
|
-
|
568
|
-
|
714
|
+
matrix_values:
|
715
|
+
T::Array[
|
716
|
+
Orb::PriceCreateParams::MatrixConfig::MatrixValue::OrHash
|
717
|
+
]
|
718
|
+
).returns(T.attached_class)
|
569
719
|
end
|
570
720
|
def self.new(
|
571
721
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
@@ -574,20 +724,31 @@ module Orb
|
|
574
724
|
dimensions:,
|
575
725
|
# Matrix values for specified matrix grouping keys
|
576
726
|
matrix_values:
|
577
|
-
)
|
727
|
+
)
|
728
|
+
end
|
729
|
+
|
578
730
|
sig do
|
579
|
-
override
|
580
|
-
|
581
|
-
|
582
|
-
|
583
|
-
|
584
|
-
|
585
|
-
|
586
|
-
|
731
|
+
override.returns(
|
732
|
+
{
|
733
|
+
default_unit_amount: String,
|
734
|
+
dimensions: T::Array[T.nilable(String)],
|
735
|
+
matrix_values:
|
736
|
+
T::Array[Orb::PriceCreateParams::MatrixConfig::MatrixValue]
|
737
|
+
}
|
738
|
+
)
|
739
|
+
end
|
740
|
+
def to_hash
|
587
741
|
end
|
588
|
-
def to_hash; end
|
589
742
|
|
590
743
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
744
|
+
OrHash =
|
745
|
+
T.type_alias do
|
746
|
+
T.any(
|
747
|
+
Orb::PriceCreateParams::MatrixConfig::MatrixValue,
|
748
|
+
Orb::Internal::AnyHash
|
749
|
+
)
|
750
|
+
end
|
751
|
+
|
591
752
|
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
592
753
|
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
593
754
|
# instance tier.
|
@@ -611,13 +772,31 @@ module Orb
|
|
611
772
|
dimension_values:,
|
612
773
|
# Unit price for the specified dimension_values
|
613
774
|
unit_amount:
|
614
|
-
)
|
615
|
-
|
616
|
-
|
775
|
+
)
|
776
|
+
end
|
777
|
+
|
778
|
+
sig do
|
779
|
+
override.returns(
|
780
|
+
{
|
781
|
+
dimension_values: T::Array[T.nilable(String)],
|
782
|
+
unit_amount: String
|
783
|
+
}
|
784
|
+
)
|
785
|
+
end
|
786
|
+
def to_hash
|
787
|
+
end
|
617
788
|
end
|
618
789
|
end
|
619
790
|
|
620
791
|
class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
|
792
|
+
OrHash =
|
793
|
+
T.type_alias do
|
794
|
+
T.any(
|
795
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig,
|
796
|
+
Orb::Internal::AnyHash
|
797
|
+
)
|
798
|
+
end
|
799
|
+
|
621
800
|
# Allocation to be used to calculate the price
|
622
801
|
sig { returns(Float) }
|
623
802
|
attr_accessor :allocation
|
@@ -631,7 +810,13 @@ module Orb
|
|
631
810
|
attr_accessor :dimensions
|
632
811
|
|
633
812
|
# Matrix values for specified matrix grouping keys
|
634
|
-
sig
|
813
|
+
sig do
|
814
|
+
returns(
|
815
|
+
T::Array[
|
816
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue
|
817
|
+
]
|
818
|
+
)
|
819
|
+
end
|
635
820
|
attr_accessor :matrix_values
|
636
821
|
|
637
822
|
sig do
|
@@ -639,9 +824,11 @@ module Orb
|
|
639
824
|
allocation: Float,
|
640
825
|
default_unit_amount: String,
|
641
826
|
dimensions: T::Array[T.nilable(String)],
|
642
|
-
matrix_values:
|
643
|
-
|
644
|
-
|
827
|
+
matrix_values:
|
828
|
+
T::Array[
|
829
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue::OrHash
|
830
|
+
]
|
831
|
+
).returns(T.attached_class)
|
645
832
|
end
|
646
833
|
def self.new(
|
647
834
|
# Allocation to be used to calculate the price
|
@@ -652,21 +839,34 @@ module Orb
|
|
652
839
|
dimensions:,
|
653
840
|
# Matrix values for specified matrix grouping keys
|
654
841
|
matrix_values:
|
655
|
-
)
|
842
|
+
)
|
843
|
+
end
|
844
|
+
|
656
845
|
sig do
|
657
|
-
override
|
658
|
-
|
659
|
-
|
660
|
-
|
661
|
-
|
662
|
-
|
663
|
-
|
664
|
-
|
665
|
-
|
846
|
+
override.returns(
|
847
|
+
{
|
848
|
+
allocation: Float,
|
849
|
+
default_unit_amount: String,
|
850
|
+
dimensions: T::Array[T.nilable(String)],
|
851
|
+
matrix_values:
|
852
|
+
T::Array[
|
853
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue
|
854
|
+
]
|
855
|
+
}
|
856
|
+
)
|
857
|
+
end
|
858
|
+
def to_hash
|
666
859
|
end
|
667
|
-
def to_hash; end
|
668
860
|
|
669
861
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
862
|
+
OrHash =
|
863
|
+
T.type_alias do
|
864
|
+
T.any(
|
865
|
+
Orb::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue,
|
866
|
+
Orb::Internal::AnyHash
|
867
|
+
)
|
868
|
+
end
|
869
|
+
|
670
870
|
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
671
871
|
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
672
872
|
# instance tier.
|
@@ -690,29 +890,60 @@ module Orb
|
|
690
890
|
dimension_values:,
|
691
891
|
# Unit price for the specified dimension_values
|
692
892
|
unit_amount:
|
693
|
-
)
|
694
|
-
|
695
|
-
|
893
|
+
)
|
894
|
+
end
|
895
|
+
|
896
|
+
sig do
|
897
|
+
override.returns(
|
898
|
+
{
|
899
|
+
dimension_values: T::Array[T.nilable(String)],
|
900
|
+
unit_amount: String
|
901
|
+
}
|
902
|
+
)
|
903
|
+
end
|
904
|
+
def to_hash
|
905
|
+
end
|
696
906
|
end
|
697
907
|
end
|
698
908
|
|
699
909
|
class TieredConfig < Orb::Internal::Type::BaseModel
|
910
|
+
OrHash =
|
911
|
+
T.type_alias do
|
912
|
+
T.any(Orb::PriceCreateParams::TieredConfig, Orb::Internal::AnyHash)
|
913
|
+
end
|
914
|
+
|
700
915
|
# Tiers for rating based on total usage quantities into the specified tier
|
701
|
-
sig { returns(T::Array[Orb::
|
916
|
+
sig { returns(T::Array[Orb::PriceCreateParams::TieredConfig::Tier]) }
|
702
917
|
attr_accessor :tiers
|
703
918
|
|
704
919
|
sig do
|
705
|
-
params(
|
706
|
-
|
920
|
+
params(
|
921
|
+
tiers: T::Array[Orb::PriceCreateParams::TieredConfig::Tier::OrHash]
|
922
|
+
).returns(T.attached_class)
|
707
923
|
end
|
708
924
|
def self.new(
|
709
925
|
# Tiers for rating based on total usage quantities into the specified tier
|
710
926
|
tiers:
|
711
|
-
)
|
712
|
-
|
713
|
-
|
927
|
+
)
|
928
|
+
end
|
929
|
+
|
930
|
+
sig do
|
931
|
+
override.returns(
|
932
|
+
{ tiers: T::Array[Orb::PriceCreateParams::TieredConfig::Tier] }
|
933
|
+
)
|
934
|
+
end
|
935
|
+
def to_hash
|
936
|
+
end
|
714
937
|
|
715
938
|
class Tier < Orb::Internal::Type::BaseModel
|
939
|
+
OrHash =
|
940
|
+
T.type_alias do
|
941
|
+
T.any(
|
942
|
+
Orb::PriceCreateParams::TieredConfig::Tier,
|
943
|
+
Orb::Internal::AnyHash
|
944
|
+
)
|
945
|
+
end
|
946
|
+
|
716
947
|
# Exclusive tier starting value
|
717
948
|
sig { returns(Float) }
|
718
949
|
attr_accessor :first_unit
|
@@ -739,33 +970,67 @@ module Orb
|
|
739
970
|
unit_amount:,
|
740
971
|
# Inclusive tier ending value. If null, this is treated as the last tier
|
741
972
|
last_unit: nil
|
742
|
-
)
|
743
|
-
|
744
|
-
|
973
|
+
)
|
974
|
+
end
|
975
|
+
|
976
|
+
sig do
|
977
|
+
override.returns(
|
978
|
+
{
|
979
|
+
first_unit: Float,
|
980
|
+
unit_amount: String,
|
981
|
+
last_unit: T.nilable(Float)
|
982
|
+
}
|
983
|
+
)
|
984
|
+
end
|
985
|
+
def to_hash
|
986
|
+
end
|
745
987
|
end
|
746
988
|
end
|
747
989
|
|
748
990
|
class TieredBpsConfig < Orb::Internal::Type::BaseModel
|
991
|
+
OrHash =
|
992
|
+
T.type_alias do
|
993
|
+
T.any(
|
994
|
+
Orb::PriceCreateParams::TieredBpsConfig,
|
995
|
+
Orb::Internal::AnyHash
|
996
|
+
)
|
997
|
+
end
|
998
|
+
|
749
999
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
750
1000
|
# tiers
|
751
|
-
sig { returns(T::Array[Orb::
|
1001
|
+
sig { returns(T::Array[Orb::PriceCreateParams::TieredBpsConfig::Tier]) }
|
752
1002
|
attr_accessor :tiers
|
753
1003
|
|
754
1004
|
sig do
|
755
1005
|
params(
|
756
|
-
tiers:
|
757
|
-
|
758
|
-
|
1006
|
+
tiers:
|
1007
|
+
T::Array[Orb::PriceCreateParams::TieredBpsConfig::Tier::OrHash]
|
1008
|
+
).returns(T.attached_class)
|
759
1009
|
end
|
760
1010
|
def self.new(
|
761
1011
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
762
1012
|
# tiers
|
763
1013
|
tiers:
|
764
|
-
)
|
765
|
-
|
766
|
-
|
1014
|
+
)
|
1015
|
+
end
|
1016
|
+
|
1017
|
+
sig do
|
1018
|
+
override.returns(
|
1019
|
+
{ tiers: T::Array[Orb::PriceCreateParams::TieredBpsConfig::Tier] }
|
1020
|
+
)
|
1021
|
+
end
|
1022
|
+
def to_hash
|
1023
|
+
end
|
767
1024
|
|
768
1025
|
class Tier < Orb::Internal::Type::BaseModel
|
1026
|
+
OrHash =
|
1027
|
+
T.type_alias do
|
1028
|
+
T.any(
|
1029
|
+
Orb::PriceCreateParams::TieredBpsConfig::Tier,
|
1030
|
+
Orb::Internal::AnyHash
|
1031
|
+
)
|
1032
|
+
end
|
1033
|
+
|
769
1034
|
# Per-event basis point rate
|
770
1035
|
sig { returns(Float) }
|
771
1036
|
attr_accessor :bps
|
@@ -788,8 +1053,7 @@ module Orb
|
|
788
1053
|
minimum_amount: String,
|
789
1054
|
maximum_amount: T.nilable(String),
|
790
1055
|
per_unit_maximum: T.nilable(String)
|
791
|
-
)
|
792
|
-
.returns(T.attached_class)
|
1056
|
+
).returns(T.attached_class)
|
793
1057
|
end
|
794
1058
|
def self.new(
|
795
1059
|
# Per-event basis point rate
|
@@ -800,23 +1064,30 @@ module Orb
|
|
800
1064
|
maximum_amount: nil,
|
801
1065
|
# Per unit maximum to charge
|
802
1066
|
per_unit_maximum: nil
|
803
|
-
)
|
1067
|
+
)
|
1068
|
+
end
|
1069
|
+
|
804
1070
|
sig do
|
805
|
-
override
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
1071
|
+
override.returns(
|
1072
|
+
{
|
1073
|
+
bps: Float,
|
1074
|
+
minimum_amount: String,
|
1075
|
+
maximum_amount: T.nilable(String),
|
1076
|
+
per_unit_maximum: T.nilable(String)
|
1077
|
+
}
|
1078
|
+
)
|
1079
|
+
end
|
1080
|
+
def to_hash
|
814
1081
|
end
|
815
|
-
def to_hash; end
|
816
1082
|
end
|
817
1083
|
end
|
818
1084
|
|
819
1085
|
class BpsConfig < Orb::Internal::Type::BaseModel
|
1086
|
+
OrHash =
|
1087
|
+
T.type_alias do
|
1088
|
+
T.any(Orb::PriceCreateParams::BpsConfig, Orb::Internal::AnyHash)
|
1089
|
+
end
|
1090
|
+
|
820
1091
|
# Basis point take rate per event
|
821
1092
|
sig { returns(Float) }
|
822
1093
|
attr_accessor :bps
|
@@ -825,38 +1096,66 @@ module Orb
|
|
825
1096
|
sig { returns(T.nilable(String)) }
|
826
1097
|
attr_accessor :per_unit_maximum
|
827
1098
|
|
828
|
-
sig
|
1099
|
+
sig do
|
1100
|
+
params(bps: Float, per_unit_maximum: T.nilable(String)).returns(
|
1101
|
+
T.attached_class
|
1102
|
+
)
|
1103
|
+
end
|
829
1104
|
def self.new(
|
830
1105
|
# Basis point take rate per event
|
831
1106
|
bps:,
|
832
1107
|
# Optional currency amount maximum to cap spend per event
|
833
1108
|
per_unit_maximum: nil
|
834
|
-
)
|
835
|
-
|
836
|
-
|
1109
|
+
)
|
1110
|
+
end
|
1111
|
+
|
1112
|
+
sig do
|
1113
|
+
override.returns({ bps: Float, per_unit_maximum: T.nilable(String) })
|
1114
|
+
end
|
1115
|
+
def to_hash
|
1116
|
+
end
|
837
1117
|
end
|
838
1118
|
|
839
1119
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
1120
|
+
OrHash =
|
1121
|
+
T.type_alias do
|
1122
|
+
T.any(Orb::PriceCreateParams::BulkBpsConfig, Orb::Internal::AnyHash)
|
1123
|
+
end
|
1124
|
+
|
840
1125
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
841
1126
|
# tier based on total volume
|
842
|
-
sig { returns(T::Array[Orb::
|
1127
|
+
sig { returns(T::Array[Orb::PriceCreateParams::BulkBpsConfig::Tier]) }
|
843
1128
|
attr_accessor :tiers
|
844
1129
|
|
845
1130
|
sig do
|
846
1131
|
params(
|
847
|
-
tiers: T::Array[
|
848
|
-
)
|
849
|
-
.returns(T.attached_class)
|
1132
|
+
tiers: T::Array[Orb::PriceCreateParams::BulkBpsConfig::Tier::OrHash]
|
1133
|
+
).returns(T.attached_class)
|
850
1134
|
end
|
851
1135
|
def self.new(
|
852
1136
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
853
1137
|
# tier based on total volume
|
854
1138
|
tiers:
|
855
|
-
)
|
856
|
-
|
857
|
-
|
1139
|
+
)
|
1140
|
+
end
|
1141
|
+
|
1142
|
+
sig do
|
1143
|
+
override.returns(
|
1144
|
+
{ tiers: T::Array[Orb::PriceCreateParams::BulkBpsConfig::Tier] }
|
1145
|
+
)
|
1146
|
+
end
|
1147
|
+
def to_hash
|
1148
|
+
end
|
858
1149
|
|
859
1150
|
class Tier < Orb::Internal::Type::BaseModel
|
1151
|
+
OrHash =
|
1152
|
+
T.type_alias do
|
1153
|
+
T.any(
|
1154
|
+
Orb::PriceCreateParams::BulkBpsConfig::Tier,
|
1155
|
+
Orb::Internal::AnyHash
|
1156
|
+
)
|
1157
|
+
end
|
1158
|
+
|
860
1159
|
# Basis points to rate on
|
861
1160
|
sig { returns(Float) }
|
862
1161
|
attr_accessor :bps
|
@@ -870,8 +1169,11 @@ module Orb
|
|
870
1169
|
attr_accessor :per_unit_maximum
|
871
1170
|
|
872
1171
|
sig do
|
873
|
-
params(
|
874
|
-
|
1172
|
+
params(
|
1173
|
+
bps: Float,
|
1174
|
+
maximum_amount: T.nilable(String),
|
1175
|
+
per_unit_maximum: T.nilable(String)
|
1176
|
+
).returns(T.attached_class)
|
875
1177
|
end
|
876
1178
|
def self.new(
|
877
1179
|
# Basis points to rate on
|
@@ -880,7 +1182,9 @@ module Orb
|
|
880
1182
|
maximum_amount: nil,
|
881
1183
|
# The maximum amount to charge for any one event
|
882
1184
|
per_unit_maximum: nil
|
883
|
-
)
|
1185
|
+
)
|
1186
|
+
end
|
1187
|
+
|
884
1188
|
sig do
|
885
1189
|
override.returns(
|
886
1190
|
{
|
@@ -890,27 +1194,49 @@ module Orb
|
|
890
1194
|
}
|
891
1195
|
)
|
892
1196
|
end
|
893
|
-
def to_hash
|
1197
|
+
def to_hash
|
1198
|
+
end
|
894
1199
|
end
|
895
1200
|
end
|
896
1201
|
|
897
1202
|
class BulkConfig < Orb::Internal::Type::BaseModel
|
1203
|
+
OrHash =
|
1204
|
+
T.type_alias do
|
1205
|
+
T.any(Orb::PriceCreateParams::BulkConfig, Orb::Internal::AnyHash)
|
1206
|
+
end
|
1207
|
+
|
898
1208
|
# Bulk tiers for rating based on total usage volume
|
899
|
-
sig { returns(T::Array[Orb::
|
1209
|
+
sig { returns(T::Array[Orb::PriceCreateParams::BulkConfig::Tier]) }
|
900
1210
|
attr_accessor :tiers
|
901
1211
|
|
902
1212
|
sig do
|
903
|
-
params(
|
904
|
-
|
1213
|
+
params(
|
1214
|
+
tiers: T::Array[Orb::PriceCreateParams::BulkConfig::Tier::OrHash]
|
1215
|
+
).returns(T.attached_class)
|
905
1216
|
end
|
906
1217
|
def self.new(
|
907
1218
|
# Bulk tiers for rating based on total usage volume
|
908
1219
|
tiers:
|
909
|
-
)
|
910
|
-
|
911
|
-
|
1220
|
+
)
|
1221
|
+
end
|
1222
|
+
|
1223
|
+
sig do
|
1224
|
+
override.returns(
|
1225
|
+
{ tiers: T::Array[Orb::PriceCreateParams::BulkConfig::Tier] }
|
1226
|
+
)
|
1227
|
+
end
|
1228
|
+
def to_hash
|
1229
|
+
end
|
912
1230
|
|
913
1231
|
class Tier < Orb::Internal::Type::BaseModel
|
1232
|
+
OrHash =
|
1233
|
+
T.type_alias do
|
1234
|
+
T.any(
|
1235
|
+
Orb::PriceCreateParams::BulkConfig::Tier,
|
1236
|
+
Orb::Internal::AnyHash
|
1237
|
+
)
|
1238
|
+
end
|
1239
|
+
|
914
1240
|
# Amount per unit
|
915
1241
|
sig { returns(String) }
|
916
1242
|
attr_accessor :unit_amount
|
@@ -919,15 +1245,27 @@ module Orb
|
|
919
1245
|
sig { returns(T.nilable(Float)) }
|
920
1246
|
attr_accessor :maximum_units
|
921
1247
|
|
922
|
-
sig
|
1248
|
+
sig do
|
1249
|
+
params(
|
1250
|
+
unit_amount: String,
|
1251
|
+
maximum_units: T.nilable(Float)
|
1252
|
+
).returns(T.attached_class)
|
1253
|
+
end
|
923
1254
|
def self.new(
|
924
1255
|
# Amount per unit
|
925
1256
|
unit_amount:,
|
926
1257
|
# Upper bound for this tier
|
927
1258
|
maximum_units: nil
|
928
|
-
)
|
929
|
-
|
930
|
-
|
1259
|
+
)
|
1260
|
+
end
|
1261
|
+
|
1262
|
+
sig do
|
1263
|
+
override.returns(
|
1264
|
+
{ unit_amount: String, maximum_units: T.nilable(Float) }
|
1265
|
+
)
|
1266
|
+
end
|
1267
|
+
def to_hash
|
1268
|
+
end
|
931
1269
|
end
|
932
1270
|
end
|
933
1271
|
end
|