orb-billing 0.1.3 → 0.3.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/.ignore +2 -0
- data/CHANGELOG.md +65 -0
- data/README.md +61 -51
- data/lib/orb/client.rb +7 -6
- data/lib/orb/file_part.rb +55 -0
- data/lib/orb/internal/page.rb +37 -39
- data/lib/orb/internal/transport/base_client.rb +21 -11
- data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
- data/lib/orb/internal/type/array_of.rb +28 -2
- data/lib/orb/internal/type/base_model.rb +83 -21
- data/lib/orb/internal/type/base_page.rb +10 -1
- data/lib/orb/internal/type/boolean.rb +6 -0
- data/lib/orb/internal/type/converter.rb +28 -1
- data/lib/orb/internal/type/enum.rb +28 -8
- data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
- data/lib/orb/internal/type/hash_of.rb +28 -2
- data/lib/orb/internal/type/request_parameters.rb +1 -2
- data/lib/orb/internal/type/union.rb +27 -4
- data/lib/orb/internal/type/unknown.rb +6 -0
- data/lib/orb/internal/util.rb +105 -70
- data/lib/orb/internal.rb +5 -2
- data/lib/orb/models/alert.rb +68 -71
- data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
- data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
- data/lib/orb/models/alert_disable_params.rb +5 -9
- data/lib/orb/models/alert_enable_params.rb +5 -9
- data/lib/orb/models/alert_list_params.rb +26 -36
- data/lib/orb/models/alert_retrieve_params.rb +3 -8
- data/lib/orb/models/alert_update_params.rb +14 -18
- data/lib/orb/models/amount_discount.rb +14 -14
- data/lib/orb/models/billable_metric.rb +23 -20
- data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
- data/lib/orb/models/coupon.rb +28 -21
- data/lib/orb/models/coupon_archive_params.rb +3 -8
- data/lib/orb/models/coupon_create_params.rb +24 -29
- data/lib/orb/models/coupon_fetch_params.rb +3 -8
- data/lib/orb/models/coupon_list_params.rb +17 -17
- data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
- data/lib/orb/models/credit_note.rb +100 -166
- data/lib/orb/models/credit_note_create_params.rb +15 -23
- data/lib/orb/models/credit_note_fetch_params.rb +3 -8
- data/lib/orb/models/credit_note_list_params.rb +20 -30
- data/lib/orb/models/customer.rb +224 -271
- data/lib/orb/models/customer_create_params.rb +211 -252
- data/lib/orb/models/customer_delete_params.rb +3 -8
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
- data/lib/orb/models/customer_fetch_params.rb +3 -8
- data/lib/orb/models/customer_list_params.rb +20 -30
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
- data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
- data/lib/orb/models/customer_update_params.rb +207 -250
- data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
- data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
- data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
- data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
- data/lib/orb/models/customers/cost_list_params.rb +17 -17
- data/lib/orb/models/customers/cost_list_response.rb +22 -26
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
- data/lib/orb/models/customers/credit_list_params.rb +18 -22
- data/lib/orb/models/customers/credit_list_response.rb +10 -17
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
- data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
- data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
- data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
- data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
- data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
- data/lib/orb/models/dimensional_price_group.rb +21 -15
- data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
- data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
- data/lib/orb/models/dimensional_price_groups.rb +3 -7
- data/lib/orb/models/discount.rb +2 -3
- data/lib/orb/models/evaluate_price_group.rb +8 -11
- data/lib/orb/models/event_deprecate_params.rb +3 -8
- data/lib/orb/models/event_deprecate_response.rb +2 -6
- data/lib/orb/models/event_ingest_params.rb +33 -27
- data/lib/orb/models/event_ingest_response.rb +23 -24
- data/lib/orb/models/event_search_params.rb +15 -11
- data/lib/orb/models/event_search_response.rb +27 -22
- data/lib/orb/models/event_update_params.rb +19 -13
- data/lib/orb/models/event_update_response.rb +2 -6
- data/lib/orb/models/events/backfill_close_params.rb +3 -8
- data/lib/orb/models/events/backfill_close_response.rb +34 -39
- data/lib/orb/models/events/backfill_create_params.rb +28 -32
- data/lib/orb/models/events/backfill_create_response.rb +34 -39
- data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
- data/lib/orb/models/events/backfill_list_params.rb +12 -15
- data/lib/orb/models/events/backfill_list_response.rb +34 -39
- data/lib/orb/models/events/backfill_revert_params.rb +3 -8
- data/lib/orb/models/events/backfill_revert_response.rb +34 -39
- data/lib/orb/models/events/event_volumes.rb +11 -17
- data/lib/orb/models/events/volume_list_params.rb +19 -22
- data/lib/orb/models/invoice.rb +589 -637
- data/lib/orb/models/invoice_create_params.rb +52 -61
- data/lib/orb/models/invoice_fetch_params.rb +3 -8
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
- data/lib/orb/models/invoice_issue_params.rb +10 -14
- data/lib/orb/models/invoice_level_discount.rb +2 -3
- data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
- data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
- data/lib/orb/models/invoice_list_params.rb +51 -66
- data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
- data/lib/orb/models/invoice_pay_params.rb +3 -8
- data/lib/orb/models/invoice_update_params.rb +9 -9
- data/lib/orb/models/invoice_void_params.rb +3 -8
- data/lib/orb/models/item.rb +14 -25
- data/lib/orb/models/item_create_params.rb +5 -9
- data/lib/orb/models/item_fetch_params.rb +3 -8
- data/lib/orb/models/item_list_params.rb +12 -15
- data/lib/orb/models/item_update_params.rb +10 -22
- data/lib/orb/models/metric_create_params.rb +17 -13
- data/lib/orb/models/metric_fetch_params.rb +3 -8
- data/lib/orb/models/metric_list_params.rb +20 -30
- data/lib/orb/models/metric_update_params.rb +9 -9
- data/lib/orb/models/pagination_metadata.rb +3 -7
- data/lib/orb/models/percentage_discount.rb +15 -14
- data/lib/orb/models/plan.rb +250 -279
- data/lib/orb/models/plan_create_params.rb +1623 -1984
- data/lib/orb/models/plan_fetch_params.rb +3 -8
- data/lib/orb/models/plan_list_params.rb +25 -42
- data/lib/orb/models/plan_update_params.rb +12 -10
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
- data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
- data/lib/orb/models/price.rb +2709 -3820
- data/lib/orb/models/price_create_params.rb +203 -244
- data/lib/orb/models/price_evaluate_params.rb +21 -30
- data/lib/orb/models/price_evaluate_response.rb +2 -6
- data/lib/orb/models/price_fetch_params.rb +3 -8
- data/lib/orb/models/price_list_params.rb +12 -15
- data/lib/orb/models/price_update_params.rb +9 -9
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
- data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
- data/lib/orb/models/subscription.rb +343 -382
- data/lib/orb/models/subscription_cancel_params.rb +16 -16
- data/lib/orb/models/subscription_cancel_response.rb +339 -377
- data/lib/orb/models/subscription_change_apply_params.rb +7 -10
- data/lib/orb/models/subscription_change_apply_response.rb +365 -398
- data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
- data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
- data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
- data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
- data/lib/orb/models/subscription_create_params.rb +3771 -4402
- data/lib/orb/models/subscription_create_response.rb +339 -377
- data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
- data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
- data/lib/orb/models/subscription_fetch_params.rb +3 -8
- data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
- data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
- data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
- data/lib/orb/models/subscription_list_params.rb +28 -41
- data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
- data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
- data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
- data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
- data/lib/orb/models/subscription_update_params.rb +21 -23
- data/lib/orb/models/subscription_update_trial_params.rb +15 -18
- data/lib/orb/models/subscription_update_trial_response.rb +341 -377
- data/lib/orb/models/subscription_usage.rb +37 -80
- data/lib/orb/models/subscriptions.rb +3 -7
- data/lib/orb/models/top_level_ping_params.rb +3 -8
- data/lib/orb/models/top_level_ping_response.rb +2 -6
- data/lib/orb/models/trial_discount.rb +16 -24
- data/lib/orb/models/usage_discount.rb +15 -14
- data/lib/orb/request_options.rb +3 -4
- data/lib/orb/resources/alerts.rb +48 -17
- data/lib/orb/resources/coupons/subscriptions.rb +9 -2
- data/lib/orb/resources/coupons.rb +25 -7
- data/lib/orb/resources/credit_notes.rb +17 -4
- data/lib/orb/resources/customers/balance_transactions.rb +18 -3
- data/lib/orb/resources/customers/costs.rb +26 -8
- data/lib/orb/resources/customers/credits/ledger.rb +108 -28
- data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
- data/lib/orb/resources/customers/credits.rb +28 -8
- data/lib/orb/resources/customers.rb +135 -36
- data/lib/orb/resources/dimensional_price_groups.rb +19 -4
- data/lib/orb/resources/events/backfills.rb +32 -9
- data/lib/orb/resources/events/volume.rb +14 -4
- data/lib/orb/resources/events.rb +40 -11
- data/lib/orb/resources/invoice_line_items.rb +16 -6
- data/lib/orb/resources/invoices.rb +77 -17
- data/lib/orb/resources/items.rb +10 -3
- data/lib/orb/resources/metrics.rb +33 -8
- data/lib/orb/resources/plans/external_plan_id.rb +10 -2
- data/lib/orb/resources/plans.rb +47 -11
- data/lib/orb/resources/prices/external_price_id.rb +7 -1
- data/lib/orb/resources/prices.rb +97 -22
- data/lib/orb/resources/subscription_changes.rb +5 -2
- data/lib/orb/resources/subscriptions.rb +292 -78
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +2 -10
- data/rbi/lib/orb/client.rbi +7 -6
- data/rbi/lib/orb/file_part.rbi +34 -0
- data/rbi/lib/orb/internal/page.rbi +1 -0
- data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
- data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
- data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
- data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
- data/rbi/lib/orb/internal/type/converter.rbi +8 -0
- data/rbi/lib/orb/internal/type/enum.rbi +7 -6
- data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
- data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
- data/rbi/lib/orb/internal/type/union.rbi +7 -0
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
- data/rbi/lib/orb/internal/util.rbi +39 -19
- data/rbi/lib/orb/internal.rbi +1 -2
- data/rbi/lib/orb/models/alert.rbi +28 -8
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
- data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
- data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
- data/rbi/lib/orb/models/amount_discount.rbi +10 -4
- data/rbi/lib/orb/models/billable_metric.rbi +16 -3
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
- data/rbi/lib/orb/models/coupon.rbi +10 -3
- data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
- data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
- data/rbi/lib/orb/models/credit_note.rbi +44 -12
- data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer.rbi +130 -11
- data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
- data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
- data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
- data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
- data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
- data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
- data/rbi/lib/orb/models/event_search_params.rbi +14 -2
- data/rbi/lib/orb/models/event_search_response.rbi +14 -3
- data/rbi/lib/orb/models/event_update_params.rbi +10 -3
- data/rbi/lib/orb/models/event_update_response.rbi +4 -2
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
- data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
- data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
- data/rbi/lib/orb/models/invoice.rbi +375 -46
- data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
- data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
- data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
- data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
- data/rbi/lib/orb/models/item.rbi +1 -2
- data/rbi/lib/orb/models/item_create_params.rbi +5 -2
- data/rbi/lib/orb/models/item_list_params.rbi +8 -2
- data/rbi/lib/orb/models/item_update_params.rbi +1 -8
- data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
- data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
- data/rbi/lib/orb/models/plan.rbi +102 -15
- data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
- data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
- data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
- data/rbi/lib/orb/models/price.rbi +717 -688
- data/rbi/lib/orb/models/price_create_params.rbi +137 -53
- data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
- data/rbi/lib/orb/models/price_list_params.rbi +8 -2
- data/rbi/lib/orb/models/price_update_params.rbi +7 -2
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription.rbi +174 -11
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
- data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
- data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
- data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
- data/rbi/lib/orb/models/trial_discount.rbi +5 -1
- data/rbi/lib/orb/models/usage_discount.rbi +11 -3
- data/sig/orb/file_part.rbs +21 -0
- data/sig/orb/internal/transport/base_client.rbs +9 -3
- data/sig/orb/internal/type/array_of.rbs +4 -0
- data/sig/orb/internal/type/base_model.rbs +12 -0
- data/sig/orb/internal/type/converter.rbs +4 -0
- data/sig/orb/internal/type/enum.rbs +4 -2
- data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
- data/sig/orb/internal/type/hash_of.rbs +4 -0
- data/sig/orb/internal/type/union.rbs +4 -0
- data/sig/orb/internal/util.rbs +16 -12
- data/sig/orb/internal.rbs +1 -1
- metadata +9 -5
@@ -4,8 +4,7 @@ module Orb
|
|
4
4
|
module Models
|
5
5
|
# @see Orb::Resources::Prices#create
|
6
6
|
class PriceCreateParams < Orb::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Orb::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Orb::Internal::Type::RequestParameters::Converter
|
9
8
|
include Orb::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute cadence
|
@@ -245,101 +244,101 @@ module Orb
|
|
245
244
|
# @return [Hash{Symbol=>Object}]
|
246
245
|
required :cumulative_grouped_bulk_config, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
|
247
246
|
|
248
|
-
# @!
|
249
|
-
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
255
|
-
#
|
256
|
-
#
|
257
|
-
#
|
258
|
-
#
|
259
|
-
#
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
#
|
265
|
-
#
|
266
|
-
#
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
273
|
-
#
|
274
|
-
#
|
275
|
-
#
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
#
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
#
|
285
|
-
#
|
286
|
-
#
|
287
|
-
#
|
288
|
-
#
|
289
|
-
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
#
|
293
|
-
#
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
#
|
303
|
-
#
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
#
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
325
|
-
#
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
336
|
-
#
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
-
#
|
341
|
-
|
342
|
-
#
|
247
|
+
# @!method initialize(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {})
|
248
|
+
# Some parameter documentations has been truncated, see
|
249
|
+
# {Orb::Models::PriceCreateParams} for more details.
|
250
|
+
#
|
251
|
+
# @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence] The cadence to bill for this price on.
|
252
|
+
#
|
253
|
+
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
254
|
+
#
|
255
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
256
|
+
#
|
257
|
+
# @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType]
|
258
|
+
#
|
259
|
+
# @param name [String] The name of the price.
|
260
|
+
#
|
261
|
+
# @param unit_config [Orb::Models::PriceCreateParams::UnitConfig]
|
262
|
+
#
|
263
|
+
# @param package_config [Orb::Models::PriceCreateParams::PackageConfig]
|
264
|
+
#
|
265
|
+
# @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig]
|
266
|
+
#
|
267
|
+
# @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig]
|
268
|
+
#
|
269
|
+
# @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig]
|
270
|
+
#
|
271
|
+
# @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig]
|
272
|
+
#
|
273
|
+
# @param bps_config [Orb::Models::PriceCreateParams::BpsConfig]
|
274
|
+
#
|
275
|
+
# @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig]
|
276
|
+
#
|
277
|
+
# @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig]
|
278
|
+
#
|
279
|
+
# @param threshold_total_amount_config [Hash{Symbol=>Object}]
|
280
|
+
#
|
281
|
+
# @param tiered_package_config [Hash{Symbol=>Object}]
|
282
|
+
#
|
283
|
+
# @param grouped_tiered_config [Hash{Symbol=>Object}]
|
284
|
+
#
|
285
|
+
# @param max_group_tiered_package_config [Hash{Symbol=>Object}]
|
286
|
+
#
|
287
|
+
# @param tiered_with_minimum_config [Hash{Symbol=>Object}]
|
288
|
+
#
|
289
|
+
# @param package_with_allocation_config [Hash{Symbol=>Object}]
|
290
|
+
#
|
291
|
+
# @param tiered_package_with_minimum_config [Hash{Symbol=>Object}]
|
292
|
+
#
|
293
|
+
# @param unit_with_percent_config [Hash{Symbol=>Object}]
|
294
|
+
#
|
295
|
+
# @param tiered_with_proration_config [Hash{Symbol=>Object}]
|
296
|
+
#
|
297
|
+
# @param unit_with_proration_config [Hash{Symbol=>Object}]
|
298
|
+
#
|
299
|
+
# @param grouped_allocation_config [Hash{Symbol=>Object}]
|
300
|
+
#
|
301
|
+
# @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
|
302
|
+
#
|
303
|
+
# @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
|
304
|
+
#
|
305
|
+
# @param matrix_with_display_name_config [Hash{Symbol=>Object}]
|
306
|
+
#
|
307
|
+
# @param bulk_with_proration_config [Hash{Symbol=>Object}]
|
308
|
+
#
|
309
|
+
# @param grouped_tiered_package_config [Hash{Symbol=>Object}]
|
310
|
+
#
|
311
|
+
# @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}]
|
312
|
+
#
|
313
|
+
# @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}]
|
314
|
+
#
|
315
|
+
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
316
|
+
#
|
317
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
318
|
+
# ...
|
319
|
+
#
|
320
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
321
|
+
# ...
|
322
|
+
#
|
323
|
+
# @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
324
|
+
# ...
|
325
|
+
#
|
326
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
327
|
+
#
|
328
|
+
# @param external_price_id [String, nil] An alias for the price.
|
329
|
+
#
|
330
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
331
|
+
# ...
|
332
|
+
#
|
333
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
334
|
+
#
|
335
|
+
# @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
336
|
+
# ...
|
337
|
+
#
|
338
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
339
|
+
# ...
|
340
|
+
#
|
341
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
343
342
|
|
344
343
|
# The cadence to bill for this price on.
|
345
344
|
module Cadence
|
@@ -352,11 +351,8 @@ module Orb
|
|
352
351
|
ONE_TIME = :one_time
|
353
352
|
CUSTOM = :custom
|
354
353
|
|
355
|
-
|
356
|
-
|
357
|
-
# @!parse
|
358
|
-
# # @return [Array<Symbol>]
|
359
|
-
# def self.values; end
|
354
|
+
# @!method self.values
|
355
|
+
# @return [Array<Symbol>]
|
360
356
|
end
|
361
357
|
|
362
358
|
module ModelType
|
@@ -364,11 +360,8 @@ module Orb
|
|
364
360
|
|
365
361
|
CUMULATIVE_GROUPED_BULK = :cumulative_grouped_bulk
|
366
362
|
|
367
|
-
|
368
|
-
|
369
|
-
# @!parse
|
370
|
-
# # @return [Array<Symbol>]
|
371
|
-
# def self.values; end
|
363
|
+
# @!method self.values
|
364
|
+
# @return [Array<Symbol>]
|
372
365
|
end
|
373
366
|
|
374
367
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
@@ -378,12 +371,8 @@ module Orb
|
|
378
371
|
# @return [String]
|
379
372
|
required :unit_amount, String
|
380
373
|
|
381
|
-
# @!
|
382
|
-
#
|
383
|
-
# #
|
384
|
-
# def initialize(unit_amount:, **) = super
|
385
|
-
|
386
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
374
|
+
# @!method initialize(unit_amount:)
|
375
|
+
# @param unit_amount [String] Rate per unit of usage
|
387
376
|
end
|
388
377
|
|
389
378
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
@@ -400,16 +389,13 @@ module Orb
|
|
400
389
|
required :duration_unit,
|
401
390
|
enum: -> { Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit }
|
402
391
|
|
403
|
-
# @!
|
404
|
-
#
|
405
|
-
#
|
406
|
-
#
|
407
|
-
#
|
408
|
-
#
|
409
|
-
#
|
410
|
-
# def initialize(duration:, duration_unit:, **) = super
|
411
|
-
|
412
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
392
|
+
# @!method initialize(duration:, duration_unit:)
|
393
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
394
|
+
# months.
|
395
|
+
#
|
396
|
+
# @param duration [Integer] The duration of the billing period.
|
397
|
+
#
|
398
|
+
# @param duration_unit [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
413
399
|
|
414
400
|
# The unit of billing period duration.
|
415
401
|
#
|
@@ -420,11 +406,8 @@ module Orb
|
|
420
406
|
DAY = :day
|
421
407
|
MONTH = :month
|
422
408
|
|
423
|
-
|
424
|
-
|
425
|
-
# @!parse
|
426
|
-
# # @return [Array<Symbol>]
|
427
|
-
# def self.values; end
|
409
|
+
# @!method self.values
|
410
|
+
# @return [Array<Symbol>]
|
428
411
|
end
|
429
412
|
end
|
430
413
|
|
@@ -442,16 +425,13 @@ module Orb
|
|
442
425
|
required :duration_unit,
|
443
426
|
enum: -> { Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit }
|
444
427
|
|
445
|
-
# @!
|
446
|
-
#
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
450
|
-
#
|
451
|
-
#
|
452
|
-
# def initialize(duration:, duration_unit:, **) = super
|
453
|
-
|
454
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
428
|
+
# @!method initialize(duration:, duration_unit:)
|
429
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
430
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
431
|
+
#
|
432
|
+
# @param duration [Integer] The duration of the billing period.
|
433
|
+
#
|
434
|
+
# @param duration_unit [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
455
435
|
|
456
436
|
# The unit of billing period duration.
|
457
437
|
#
|
@@ -462,11 +442,8 @@ module Orb
|
|
462
442
|
DAY = :day
|
463
443
|
MONTH = :month
|
464
444
|
|
465
|
-
|
466
|
-
|
467
|
-
# @!parse
|
468
|
-
# # @return [Array<Symbol>]
|
469
|
-
# def self.values; end
|
445
|
+
# @!method self.values
|
446
|
+
# @return [Array<Symbol>]
|
470
447
|
end
|
471
448
|
end
|
472
449
|
|
@@ -484,13 +461,14 @@ module Orb
|
|
484
461
|
# @return [Integer]
|
485
462
|
required :package_size, Integer
|
486
463
|
|
487
|
-
# @!
|
488
|
-
#
|
489
|
-
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
|
493
|
-
#
|
464
|
+
# @!method initialize(package_amount:, package_size:)
|
465
|
+
# Some parameter documentations has been truncated, see
|
466
|
+
# {Orb::Models::PriceCreateParams::PackageConfig} for more details.
|
467
|
+
#
|
468
|
+
# @param package_amount [String] A currency amount to rate usage by
|
469
|
+
#
|
470
|
+
# @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
|
471
|
+
# ...
|
494
472
|
end
|
495
473
|
|
496
474
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
@@ -513,14 +491,12 @@ module Orb
|
|
513
491
|
required :matrix_values,
|
514
492
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue] }
|
515
493
|
|
516
|
-
# @!
|
517
|
-
#
|
518
|
-
#
|
519
|
-
#
|
520
|
-
#
|
521
|
-
#
|
522
|
-
|
523
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
494
|
+
# @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
|
495
|
+
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
496
|
+
#
|
497
|
+
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
498
|
+
#
|
499
|
+
# @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
524
500
|
|
525
501
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
526
502
|
# @!attribute dimension_values
|
@@ -537,13 +513,14 @@ module Orb
|
|
537
513
|
# @return [String]
|
538
514
|
required :unit_amount, String
|
539
515
|
|
540
|
-
# @!
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
544
|
-
#
|
545
|
-
|
546
|
-
#
|
516
|
+
# @!method initialize(dimension_values:, unit_amount:)
|
517
|
+
# Some parameter documentations has been truncated, see
|
518
|
+
# {Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue} for more details.
|
519
|
+
#
|
520
|
+
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
521
|
+
# ...
|
522
|
+
#
|
523
|
+
# @param unit_amount [String] Unit price for the specified dimension_values
|
547
524
|
end
|
548
525
|
end
|
549
526
|
|
@@ -573,15 +550,14 @@ module Orb
|
|
573
550
|
required :matrix_values,
|
574
551
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue] }
|
575
552
|
|
576
|
-
# @!
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
580
|
-
#
|
581
|
-
#
|
582
|
-
#
|
583
|
-
|
584
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
553
|
+
# @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:)
|
554
|
+
# @param allocation [Float] Allocation to be used to calculate the price
|
555
|
+
#
|
556
|
+
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
557
|
+
#
|
558
|
+
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
559
|
+
#
|
560
|
+
# @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
585
561
|
|
586
562
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
587
563
|
# @!attribute dimension_values
|
@@ -598,13 +574,15 @@ module Orb
|
|
598
574
|
# @return [String]
|
599
575
|
required :unit_amount, String
|
600
576
|
|
601
|
-
# @!
|
602
|
-
#
|
603
|
-
#
|
604
|
-
#
|
605
|
-
#
|
606
|
-
|
607
|
-
#
|
577
|
+
# @!method initialize(dimension_values:, unit_amount:)
|
578
|
+
# Some parameter documentations has been truncated, see
|
579
|
+
# {Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue} for
|
580
|
+
# more details.
|
581
|
+
#
|
582
|
+
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
583
|
+
# ...
|
584
|
+
#
|
585
|
+
# @param unit_amount [String] Unit price for the specified dimension_values
|
608
586
|
end
|
609
587
|
end
|
610
588
|
|
@@ -615,12 +593,8 @@ module Orb
|
|
615
593
|
# @return [Array<Orb::Models::PriceCreateParams::TieredConfig::Tier>]
|
616
594
|
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::TieredConfig::Tier] }
|
617
595
|
|
618
|
-
# @!
|
619
|
-
#
|
620
|
-
# #
|
621
|
-
# def initialize(tiers:, **) = super
|
622
|
-
|
623
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
596
|
+
# @!method initialize(tiers:)
|
597
|
+
# @param tiers [Array<Orb::Models::PriceCreateParams::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
624
598
|
|
625
599
|
class Tier < Orb::Internal::Type::BaseModel
|
626
600
|
# @!attribute first_unit
|
@@ -641,14 +615,12 @@ module Orb
|
|
641
615
|
# @return [Float, nil]
|
642
616
|
optional :last_unit, Float, nil?: true
|
643
617
|
|
644
|
-
# @!
|
645
|
-
#
|
646
|
-
#
|
647
|
-
#
|
648
|
-
#
|
649
|
-
#
|
650
|
-
|
651
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
618
|
+
# @!method initialize(first_unit:, unit_amount:, last_unit: nil)
|
619
|
+
# @param first_unit [Float] Exclusive tier starting value
|
620
|
+
#
|
621
|
+
# @param unit_amount [String] Amount per unit
|
622
|
+
#
|
623
|
+
# @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier
|
652
624
|
end
|
653
625
|
end
|
654
626
|
|
@@ -661,12 +633,12 @@ module Orb
|
|
661
633
|
required :tiers,
|
662
634
|
-> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier] }
|
663
635
|
|
664
|
-
# @!
|
665
|
-
#
|
666
|
-
#
|
667
|
-
#
|
668
|
-
|
669
|
-
#
|
636
|
+
# @!method initialize(tiers:)
|
637
|
+
# Some parameter documentations has been truncated, see
|
638
|
+
# {Orb::Models::PriceCreateParams::TieredBpsConfig} for more details.
|
639
|
+
#
|
640
|
+
# @param tiers [Array<Orb::Models::PriceCreateParams::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
641
|
+
# ...
|
670
642
|
|
671
643
|
class Tier < Orb::Internal::Type::BaseModel
|
672
644
|
# @!attribute bps
|
@@ -693,15 +665,14 @@ module Orb
|
|
693
665
|
# @return [String, nil]
|
694
666
|
optional :per_unit_maximum, String, nil?: true
|
695
667
|
|
696
|
-
# @!
|
697
|
-
#
|
698
|
-
#
|
699
|
-
#
|
700
|
-
#
|
701
|
-
#
|
702
|
-
#
|
703
|
-
|
704
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
668
|
+
# @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil)
|
669
|
+
# @param bps [Float] Per-event basis point rate
|
670
|
+
#
|
671
|
+
# @param minimum_amount [String] Exclusive tier starting value
|
672
|
+
#
|
673
|
+
# @param maximum_amount [String, nil] Inclusive tier ending value
|
674
|
+
#
|
675
|
+
# @param per_unit_maximum [String, nil] Per unit maximum to charge
|
705
676
|
end
|
706
677
|
end
|
707
678
|
|
@@ -718,13 +689,10 @@ module Orb
|
|
718
689
|
# @return [String, nil]
|
719
690
|
optional :per_unit_maximum, String, nil?: true
|
720
691
|
|
721
|
-
# @!
|
722
|
-
#
|
723
|
-
#
|
724
|
-
#
|
725
|
-
# def initialize(bps:, per_unit_maximum: nil, **) = super
|
726
|
-
|
727
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
692
|
+
# @!method initialize(bps:, per_unit_maximum: nil)
|
693
|
+
# @param bps [Float] Basis point take rate per event
|
694
|
+
#
|
695
|
+
# @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event
|
728
696
|
end
|
729
697
|
|
730
698
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
@@ -735,12 +703,12 @@ module Orb
|
|
735
703
|
# @return [Array<Orb::Models::PriceCreateParams::BulkBpsConfig::Tier>]
|
736
704
|
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier] }
|
737
705
|
|
738
|
-
# @!
|
739
|
-
#
|
740
|
-
#
|
741
|
-
#
|
742
|
-
|
743
|
-
#
|
706
|
+
# @!method initialize(tiers:)
|
707
|
+
# Some parameter documentations has been truncated, see
|
708
|
+
# {Orb::Models::PriceCreateParams::BulkBpsConfig} for more details.
|
709
|
+
#
|
710
|
+
# @param tiers [Array<Orb::Models::PriceCreateParams::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
711
|
+
# ...
|
744
712
|
|
745
713
|
class Tier < Orb::Internal::Type::BaseModel
|
746
714
|
# @!attribute bps
|
@@ -761,14 +729,12 @@ module Orb
|
|
761
729
|
# @return [String, nil]
|
762
730
|
optional :per_unit_maximum, String, nil?: true
|
763
731
|
|
764
|
-
# @!
|
765
|
-
#
|
766
|
-
#
|
767
|
-
#
|
768
|
-
#
|
769
|
-
#
|
770
|
-
|
771
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
732
|
+
# @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil)
|
733
|
+
# @param bps [Float] Basis points to rate on
|
734
|
+
#
|
735
|
+
# @param maximum_amount [String, nil] Upper bound for tier
|
736
|
+
#
|
737
|
+
# @param per_unit_maximum [String, nil] The maximum amount to charge for any one event
|
772
738
|
end
|
773
739
|
end
|
774
740
|
|
@@ -779,12 +745,8 @@ module Orb
|
|
779
745
|
# @return [Array<Orb::Models::PriceCreateParams::BulkConfig::Tier>]
|
780
746
|
required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::BulkConfig::Tier] }
|
781
747
|
|
782
|
-
# @!
|
783
|
-
#
|
784
|
-
# #
|
785
|
-
# def initialize(tiers:, **) = super
|
786
|
-
|
787
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
748
|
+
# @!method initialize(tiers:)
|
749
|
+
# @param tiers [Array<Orb::Models::PriceCreateParams::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
788
750
|
|
789
751
|
class Tier < Orb::Internal::Type::BaseModel
|
790
752
|
# @!attribute unit_amount
|
@@ -799,13 +761,10 @@ module Orb
|
|
799
761
|
# @return [Float, nil]
|
800
762
|
optional :maximum_units, Float, nil?: true
|
801
763
|
|
802
|
-
# @!
|
803
|
-
#
|
804
|
-
#
|
805
|
-
#
|
806
|
-
# def initialize(unit_amount:, maximum_units: nil, **) = super
|
807
|
-
|
808
|
-
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
764
|
+
# @!method initialize(unit_amount:, maximum_units: nil)
|
765
|
+
# @param unit_amount [String] Amount per unit
|
766
|
+
#
|
767
|
+
# @param maximum_units [Float, nil] Upper bound for this tier
|
809
768
|
end
|
810
769
|
end
|
811
770
|
end
|