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
@@ -122,13 +122,26 @@ module Orb
|
|
122
122
|
.returns(T.attached_class)
|
123
123
|
end
|
124
124
|
def self.new(
|
125
|
+
# An ISO 4217 currency string for invoices generated by subscriptions on this
|
126
|
+
# plan.
|
125
127
|
currency:,
|
126
128
|
name:,
|
129
|
+
# Prices for this plan. If the plan has phases, this includes prices across all
|
130
|
+
# phases of the plan.
|
127
131
|
prices:,
|
132
|
+
# Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
128
133
|
default_invoice_memo: nil,
|
129
134
|
external_plan_id: nil,
|
135
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
136
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
137
|
+
# by setting `metadata` to `null`.
|
130
138
|
metadata: nil,
|
139
|
+
# The net terms determines the difference between the invoice date and the issue
|
140
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
141
|
+
# to 0.
|
131
142
|
net_terms: nil,
|
143
|
+
# The status of the plan to create (either active or draft). If not specified,
|
144
|
+
# this defaults to active.
|
132
145
|
status: nil,
|
133
146
|
request_options: {}
|
134
147
|
); end
|
@@ -313,19 +326,40 @@ module Orb
|
|
313
326
|
.returns(T.attached_class)
|
314
327
|
end
|
315
328
|
def self.new(
|
329
|
+
# The cadence to bill for this price on.
|
316
330
|
cadence:,
|
331
|
+
# The id of the item the price will be associated with.
|
317
332
|
item_id:,
|
333
|
+
# The name of the price.
|
318
334
|
name:,
|
319
335
|
unit_config:,
|
336
|
+
# The id of the billable metric for the price. Only needed if the price is
|
337
|
+
# usage-based.
|
320
338
|
billable_metric_id: nil,
|
339
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
340
|
+
# this is true, and in-arrears if this is false.
|
321
341
|
billed_in_advance: nil,
|
342
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
343
|
+
# months.
|
322
344
|
billing_cycle_configuration: nil,
|
345
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
323
346
|
conversion_rate: nil,
|
347
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
348
|
+
# price is billed.
|
324
349
|
currency: nil,
|
350
|
+
# An alias for the price.
|
325
351
|
external_price_id: nil,
|
352
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
353
|
+
# applied.
|
326
354
|
fixed_price_quantity: nil,
|
355
|
+
# The property used to group this price on an invoice
|
327
356
|
invoice_grouping_key: nil,
|
357
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
358
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
328
359
|
invoicing_cycle_configuration: nil,
|
360
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
361
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
362
|
+
# by setting `metadata` to `null`.
|
329
363
|
metadata: nil,
|
330
364
|
model_type: :unit
|
331
365
|
); end
|
@@ -359,8 +393,7 @@ module Orb
|
|
359
393
|
|
360
394
|
TaggedSymbol =
|
361
395
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence) }
|
362
|
-
OrSymbol =
|
363
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence::TaggedSymbol) }
|
396
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
364
397
|
|
365
398
|
ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::Cadence::TaggedSymbol)
|
366
399
|
SEMI_ANNUAL =
|
@@ -382,8 +415,10 @@ module Orb
|
|
382
415
|
attr_accessor :unit_amount
|
383
416
|
|
384
417
|
sig { params(unit_amount: String).returns(T.attached_class) }
|
385
|
-
def self.new(
|
386
|
-
|
418
|
+
def self.new(
|
419
|
+
# Rate per unit of usage
|
420
|
+
unit_amount:
|
421
|
+
); end
|
387
422
|
sig { override.returns({unit_amount: String}) }
|
388
423
|
def to_hash; end
|
389
424
|
end
|
@@ -410,8 +445,12 @@ module Orb
|
|
410
445
|
)
|
411
446
|
.returns(T.attached_class)
|
412
447
|
end
|
413
|
-
def self.new(
|
414
|
-
|
448
|
+
def self.new(
|
449
|
+
# The duration of the billing period.
|
450
|
+
duration:,
|
451
|
+
# The unit of billing period duration.
|
452
|
+
duration_unit:
|
453
|
+
); end
|
415
454
|
sig do
|
416
455
|
override
|
417
456
|
.returns(
|
@@ -431,14 +470,7 @@ module Orb
|
|
431
470
|
T.type_alias do
|
432
471
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit)
|
433
472
|
end
|
434
|
-
OrSymbol =
|
435
|
-
T.type_alias do
|
436
|
-
T.any(
|
437
|
-
Symbol,
|
438
|
-
String,
|
439
|
-
Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
440
|
-
)
|
441
|
-
end
|
473
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
442
474
|
|
443
475
|
DAY =
|
444
476
|
T.let(
|
@@ -485,8 +517,12 @@ module Orb
|
|
485
517
|
)
|
486
518
|
.returns(T.attached_class)
|
487
519
|
end
|
488
|
-
def self.new(
|
489
|
-
|
520
|
+
def self.new(
|
521
|
+
# The duration of the billing period.
|
522
|
+
duration:,
|
523
|
+
# The unit of billing period duration.
|
524
|
+
duration_unit:
|
525
|
+
); end
|
490
526
|
sig do
|
491
527
|
override
|
492
528
|
.returns(
|
@@ -506,14 +542,7 @@ module Orb
|
|
506
542
|
T.type_alias do
|
507
543
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit)
|
508
544
|
end
|
509
|
-
OrSymbol =
|
510
|
-
T.type_alias do
|
511
|
-
T.any(
|
512
|
-
Symbol,
|
513
|
-
String,
|
514
|
-
Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
515
|
-
)
|
516
|
-
end
|
545
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
517
546
|
|
518
547
|
DAY =
|
519
548
|
T.let(
|
@@ -671,19 +700,40 @@ module Orb
|
|
671
700
|
.returns(T.attached_class)
|
672
701
|
end
|
673
702
|
def self.new(
|
703
|
+
# The cadence to bill for this price on.
|
674
704
|
cadence:,
|
705
|
+
# The id of the item the price will be associated with.
|
675
706
|
item_id:,
|
707
|
+
# The name of the price.
|
676
708
|
name:,
|
677
709
|
package_config:,
|
710
|
+
# The id of the billable metric for the price. Only needed if the price is
|
711
|
+
# usage-based.
|
678
712
|
billable_metric_id: nil,
|
713
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
714
|
+
# this is true, and in-arrears if this is false.
|
679
715
|
billed_in_advance: nil,
|
716
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
717
|
+
# months.
|
680
718
|
billing_cycle_configuration: nil,
|
719
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
681
720
|
conversion_rate: nil,
|
721
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
722
|
+
# price is billed.
|
682
723
|
currency: nil,
|
724
|
+
# An alias for the price.
|
683
725
|
external_price_id: nil,
|
726
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
727
|
+
# applied.
|
684
728
|
fixed_price_quantity: nil,
|
729
|
+
# The property used to group this price on an invoice
|
685
730
|
invoice_grouping_key: nil,
|
731
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
732
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
686
733
|
invoicing_cycle_configuration: nil,
|
734
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
735
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
736
|
+
# by setting `metadata` to `null`.
|
687
737
|
metadata: nil,
|
688
738
|
model_type: :package
|
689
739
|
); end
|
@@ -717,8 +767,7 @@ module Orb
|
|
717
767
|
|
718
768
|
TaggedSymbol =
|
719
769
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence) }
|
720
|
-
OrSymbol =
|
721
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence::TaggedSymbol) }
|
770
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
722
771
|
|
723
772
|
ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::Cadence::TaggedSymbol)
|
724
773
|
SEMI_ANNUAL =
|
@@ -749,8 +798,13 @@ module Orb
|
|
749
798
|
attr_accessor :package_size
|
750
799
|
|
751
800
|
sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) }
|
752
|
-
def self.new(
|
753
|
-
|
801
|
+
def self.new(
|
802
|
+
# A currency amount to rate usage by
|
803
|
+
package_amount:,
|
804
|
+
# An integer amount to represent package size. For example, 1000 here would divide
|
805
|
+
# usage by 1000 before multiplying by package_amount in rating
|
806
|
+
package_size:
|
807
|
+
); end
|
754
808
|
sig { override.returns({package_amount: String, package_size: Integer}) }
|
755
809
|
def to_hash; end
|
756
810
|
end
|
@@ -777,8 +831,12 @@ module Orb
|
|
777
831
|
)
|
778
832
|
.returns(T.attached_class)
|
779
833
|
end
|
780
|
-
def self.new(
|
781
|
-
|
834
|
+
def self.new(
|
835
|
+
# The duration of the billing period.
|
836
|
+
duration:,
|
837
|
+
# The unit of billing period duration.
|
838
|
+
duration_unit:
|
839
|
+
); end
|
782
840
|
sig do
|
783
841
|
override
|
784
842
|
.returns(
|
@@ -798,14 +856,7 @@ module Orb
|
|
798
856
|
T.type_alias do
|
799
857
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit)
|
800
858
|
end
|
801
|
-
OrSymbol =
|
802
|
-
T.type_alias do
|
803
|
-
T.any(
|
804
|
-
Symbol,
|
805
|
-
String,
|
806
|
-
Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
807
|
-
)
|
808
|
-
end
|
859
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
809
860
|
|
810
861
|
DAY =
|
811
862
|
T.let(
|
@@ -852,8 +903,12 @@ module Orb
|
|
852
903
|
)
|
853
904
|
.returns(T.attached_class)
|
854
905
|
end
|
855
|
-
def self.new(
|
856
|
-
|
906
|
+
def self.new(
|
907
|
+
# The duration of the billing period.
|
908
|
+
duration:,
|
909
|
+
# The unit of billing period duration.
|
910
|
+
duration_unit:
|
911
|
+
); end
|
857
912
|
sig do
|
858
913
|
override
|
859
914
|
.returns(
|
@@ -873,14 +928,7 @@ module Orb
|
|
873
928
|
T.type_alias do
|
874
929
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit)
|
875
930
|
end
|
876
|
-
OrSymbol =
|
877
|
-
T.type_alias do
|
878
|
-
T.any(
|
879
|
-
Symbol,
|
880
|
-
String,
|
881
|
-
Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
882
|
-
)
|
883
|
-
end
|
931
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
884
932
|
|
885
933
|
DAY =
|
886
934
|
T.let(
|
@@ -1038,19 +1086,40 @@ module Orb
|
|
1038
1086
|
.returns(T.attached_class)
|
1039
1087
|
end
|
1040
1088
|
def self.new(
|
1089
|
+
# The cadence to bill for this price on.
|
1041
1090
|
cadence:,
|
1091
|
+
# The id of the item the price will be associated with.
|
1042
1092
|
item_id:,
|
1043
1093
|
matrix_config:,
|
1094
|
+
# The name of the price.
|
1044
1095
|
name:,
|
1096
|
+
# The id of the billable metric for the price. Only needed if the price is
|
1097
|
+
# usage-based.
|
1045
1098
|
billable_metric_id: nil,
|
1099
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
1100
|
+
# this is true, and in-arrears if this is false.
|
1046
1101
|
billed_in_advance: nil,
|
1102
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
1103
|
+
# months.
|
1047
1104
|
billing_cycle_configuration: nil,
|
1105
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
1048
1106
|
conversion_rate: nil,
|
1107
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
1108
|
+
# price is billed.
|
1049
1109
|
currency: nil,
|
1110
|
+
# An alias for the price.
|
1050
1111
|
external_price_id: nil,
|
1112
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
1113
|
+
# applied.
|
1051
1114
|
fixed_price_quantity: nil,
|
1115
|
+
# The property used to group this price on an invoice
|
1052
1116
|
invoice_grouping_key: nil,
|
1117
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1118
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
1053
1119
|
invoicing_cycle_configuration: nil,
|
1120
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
1121
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
1122
|
+
# by setting `metadata` to `null`.
|
1054
1123
|
metadata: nil,
|
1055
1124
|
model_type: :matrix
|
1056
1125
|
); end
|
@@ -1084,8 +1153,7 @@ module Orb
|
|
1084
1153
|
|
1085
1154
|
TaggedSymbol =
|
1086
1155
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence) }
|
1087
|
-
OrSymbol =
|
1088
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence::TaggedSymbol) }
|
1156
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1089
1157
|
|
1090
1158
|
ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::Cadence::TaggedSymbol)
|
1091
1159
|
SEMI_ANNUAL =
|
@@ -1130,8 +1198,14 @@ module Orb
|
|
1130
1198
|
)
|
1131
1199
|
.returns(T.attached_class)
|
1132
1200
|
end
|
1133
|
-
def self.new(
|
1134
|
-
|
1201
|
+
def self.new(
|
1202
|
+
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
1203
|
+
default_unit_amount:,
|
1204
|
+
# One or two event property values to evaluate matrix groups by
|
1205
|
+
dimensions:,
|
1206
|
+
# Matrix values for specified matrix grouping keys
|
1207
|
+
matrix_values:
|
1208
|
+
); end
|
1135
1209
|
sig do
|
1136
1210
|
override
|
1137
1211
|
.returns(
|
@@ -1161,8 +1235,14 @@ module Orb
|
|
1161
1235
|
unit_amount: String
|
1162
1236
|
).returns(T.attached_class)
|
1163
1237
|
end
|
1164
|
-
def self.new(
|
1165
|
-
|
1238
|
+
def self.new(
|
1239
|
+
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
1240
|
+
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
1241
|
+
# instance tier.
|
1242
|
+
dimension_values:,
|
1243
|
+
# Unit price for the specified dimension_values
|
1244
|
+
unit_amount:
|
1245
|
+
); end
|
1166
1246
|
sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) }
|
1167
1247
|
def to_hash; end
|
1168
1248
|
end
|
@@ -1190,8 +1270,12 @@ module Orb
|
|
1190
1270
|
)
|
1191
1271
|
.returns(T.attached_class)
|
1192
1272
|
end
|
1193
|
-
def self.new(
|
1194
|
-
|
1273
|
+
def self.new(
|
1274
|
+
# The duration of the billing period.
|
1275
|
+
duration:,
|
1276
|
+
# The unit of billing period duration.
|
1277
|
+
duration_unit:
|
1278
|
+
); end
|
1195
1279
|
sig do
|
1196
1280
|
override
|
1197
1281
|
.returns(
|
@@ -1211,14 +1295,7 @@ module Orb
|
|
1211
1295
|
T.type_alias do
|
1212
1296
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit)
|
1213
1297
|
end
|
1214
|
-
OrSymbol =
|
1215
|
-
T.type_alias do
|
1216
|
-
T.any(
|
1217
|
-
Symbol,
|
1218
|
-
String,
|
1219
|
-
Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
1220
|
-
)
|
1221
|
-
end
|
1298
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1222
1299
|
|
1223
1300
|
DAY =
|
1224
1301
|
T.let(
|
@@ -1265,8 +1342,12 @@ module Orb
|
|
1265
1342
|
)
|
1266
1343
|
.returns(T.attached_class)
|
1267
1344
|
end
|
1268
|
-
def self.new(
|
1269
|
-
|
1345
|
+
def self.new(
|
1346
|
+
# The duration of the billing period.
|
1347
|
+
duration:,
|
1348
|
+
# The unit of billing period duration.
|
1349
|
+
duration_unit:
|
1350
|
+
); end
|
1270
1351
|
sig do
|
1271
1352
|
override
|
1272
1353
|
.returns(
|
@@ -1286,14 +1367,7 @@ module Orb
|
|
1286
1367
|
T.type_alias do
|
1287
1368
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit)
|
1288
1369
|
end
|
1289
|
-
OrSymbol =
|
1290
|
-
T.type_alias do
|
1291
|
-
T.any(
|
1292
|
-
Symbol,
|
1293
|
-
String,
|
1294
|
-
Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
1295
|
-
)
|
1296
|
-
end
|
1370
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1297
1371
|
|
1298
1372
|
DAY =
|
1299
1373
|
T.let(
|
@@ -1451,19 +1525,40 @@ module Orb
|
|
1451
1525
|
.returns(T.attached_class)
|
1452
1526
|
end
|
1453
1527
|
def self.new(
|
1528
|
+
# The cadence to bill for this price on.
|
1454
1529
|
cadence:,
|
1530
|
+
# The id of the item the price will be associated with.
|
1455
1531
|
item_id:,
|
1532
|
+
# The name of the price.
|
1456
1533
|
name:,
|
1457
1534
|
tiered_config:,
|
1535
|
+
# The id of the billable metric for the price. Only needed if the price is
|
1536
|
+
# usage-based.
|
1458
1537
|
billable_metric_id: nil,
|
1538
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
1539
|
+
# this is true, and in-arrears if this is false.
|
1459
1540
|
billed_in_advance: nil,
|
1541
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
1542
|
+
# months.
|
1460
1543
|
billing_cycle_configuration: nil,
|
1544
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
1461
1545
|
conversion_rate: nil,
|
1546
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
1547
|
+
# price is billed.
|
1462
1548
|
currency: nil,
|
1549
|
+
# An alias for the price.
|
1463
1550
|
external_price_id: nil,
|
1551
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
1552
|
+
# applied.
|
1464
1553
|
fixed_price_quantity: nil,
|
1554
|
+
# The property used to group this price on an invoice
|
1465
1555
|
invoice_grouping_key: nil,
|
1556
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1557
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
1466
1558
|
invoicing_cycle_configuration: nil,
|
1559
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
1560
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
1561
|
+
# by setting `metadata` to `null`.
|
1467
1562
|
metadata: nil,
|
1468
1563
|
model_type: :tiered
|
1469
1564
|
); end
|
@@ -1497,8 +1592,7 @@ module Orb
|
|
1497
1592
|
|
1498
1593
|
TaggedSymbol =
|
1499
1594
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence) }
|
1500
|
-
OrSymbol =
|
1501
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence::TaggedSymbol) }
|
1595
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1502
1596
|
|
1503
1597
|
ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::Cadence::TaggedSymbol)
|
1504
1598
|
SEMI_ANNUAL =
|
@@ -1533,8 +1627,10 @@ module Orb
|
|
1533
1627
|
)
|
1534
1628
|
.returns(T.attached_class)
|
1535
1629
|
end
|
1536
|
-
def self.new(
|
1537
|
-
|
1630
|
+
def self.new(
|
1631
|
+
# Tiers for rating based on total usage quantities into the specified tier
|
1632
|
+
tiers:
|
1633
|
+
); end
|
1538
1634
|
sig do
|
1539
1635
|
override
|
1540
1636
|
.returns({tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::TieredConfig::Tier]})
|
@@ -1561,8 +1657,14 @@ module Orb
|
|
1561
1657
|
last_unit: T.nilable(Float)
|
1562
1658
|
).returns(T.attached_class)
|
1563
1659
|
end
|
1564
|
-
def self.new(
|
1565
|
-
|
1660
|
+
def self.new(
|
1661
|
+
# Exclusive tier starting value
|
1662
|
+
first_unit:,
|
1663
|
+
# Amount per unit
|
1664
|
+
unit_amount:,
|
1665
|
+
# Inclusive tier ending value. If null, this is treated as the last tier
|
1666
|
+
last_unit: nil
|
1667
|
+
); end
|
1566
1668
|
sig { override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) }
|
1567
1669
|
def to_hash; end
|
1568
1670
|
end
|
@@ -1590,8 +1692,12 @@ module Orb
|
|
1590
1692
|
)
|
1591
1693
|
.returns(T.attached_class)
|
1592
1694
|
end
|
1593
|
-
def self.new(
|
1594
|
-
|
1695
|
+
def self.new(
|
1696
|
+
# The duration of the billing period.
|
1697
|
+
duration:,
|
1698
|
+
# The unit of billing period duration.
|
1699
|
+
duration_unit:
|
1700
|
+
); end
|
1595
1701
|
sig do
|
1596
1702
|
override
|
1597
1703
|
.returns(
|
@@ -1611,14 +1717,7 @@ module Orb
|
|
1611
1717
|
T.type_alias do
|
1612
1718
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit)
|
1613
1719
|
end
|
1614
|
-
OrSymbol =
|
1615
|
-
T.type_alias do
|
1616
|
-
T.any(
|
1617
|
-
Symbol,
|
1618
|
-
String,
|
1619
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
1620
|
-
)
|
1621
|
-
end
|
1720
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1622
1721
|
|
1623
1722
|
DAY =
|
1624
1723
|
T.let(
|
@@ -1665,8 +1764,12 @@ module Orb
|
|
1665
1764
|
)
|
1666
1765
|
.returns(T.attached_class)
|
1667
1766
|
end
|
1668
|
-
def self.new(
|
1669
|
-
|
1767
|
+
def self.new(
|
1768
|
+
# The duration of the billing period.
|
1769
|
+
duration:,
|
1770
|
+
# The unit of billing period duration.
|
1771
|
+
duration_unit:
|
1772
|
+
); end
|
1670
1773
|
sig do
|
1671
1774
|
override
|
1672
1775
|
.returns(
|
@@ -1686,14 +1789,7 @@ module Orb
|
|
1686
1789
|
T.type_alias do
|
1687
1790
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit)
|
1688
1791
|
end
|
1689
|
-
OrSymbol =
|
1690
|
-
T.type_alias do
|
1691
|
-
T.any(
|
1692
|
-
Symbol,
|
1693
|
-
String,
|
1694
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
1695
|
-
)
|
1696
|
-
end
|
1792
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1697
1793
|
|
1698
1794
|
DAY =
|
1699
1795
|
T.let(
|
@@ -1861,19 +1957,40 @@ module Orb
|
|
1861
1957
|
.returns(T.attached_class)
|
1862
1958
|
end
|
1863
1959
|
def self.new(
|
1960
|
+
# The cadence to bill for this price on.
|
1864
1961
|
cadence:,
|
1962
|
+
# The id of the item the price will be associated with.
|
1865
1963
|
item_id:,
|
1964
|
+
# The name of the price.
|
1866
1965
|
name:,
|
1867
1966
|
tiered_bps_config:,
|
1967
|
+
# The id of the billable metric for the price. Only needed if the price is
|
1968
|
+
# usage-based.
|
1868
1969
|
billable_metric_id: nil,
|
1970
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
1971
|
+
# this is true, and in-arrears if this is false.
|
1869
1972
|
billed_in_advance: nil,
|
1973
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
1974
|
+
# months.
|
1870
1975
|
billing_cycle_configuration: nil,
|
1976
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
1871
1977
|
conversion_rate: nil,
|
1978
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
1979
|
+
# price is billed.
|
1872
1980
|
currency: nil,
|
1981
|
+
# An alias for the price.
|
1873
1982
|
external_price_id: nil,
|
1983
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
1984
|
+
# applied.
|
1874
1985
|
fixed_price_quantity: nil,
|
1986
|
+
# The property used to group this price on an invoice
|
1875
1987
|
invoice_grouping_key: nil,
|
1988
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1989
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
1876
1990
|
invoicing_cycle_configuration: nil,
|
1991
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
1992
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
1993
|
+
# by setting `metadata` to `null`.
|
1877
1994
|
metadata: nil,
|
1878
1995
|
model_type: :tiered_bps
|
1879
1996
|
); end
|
@@ -1907,8 +2024,7 @@ module Orb
|
|
1907
2024
|
|
1908
2025
|
TaggedSymbol =
|
1909
2026
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence) }
|
1910
|
-
OrSymbol =
|
1911
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence::TaggedSymbol) }
|
2027
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
1912
2028
|
|
1913
2029
|
ANNUAL =
|
1914
2030
|
T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::Cadence::TaggedSymbol)
|
@@ -1947,8 +2063,11 @@ module Orb
|
|
1947
2063
|
)
|
1948
2064
|
.returns(T.attached_class)
|
1949
2065
|
end
|
1950
|
-
def self.new(
|
1951
|
-
|
2066
|
+
def self.new(
|
2067
|
+
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
2068
|
+
# tiers
|
2069
|
+
tiers:
|
2070
|
+
); end
|
1952
2071
|
sig do
|
1953
2072
|
override
|
1954
2073
|
.returns(
|
@@ -1983,8 +2102,16 @@ module Orb
|
|
1983
2102
|
)
|
1984
2103
|
.returns(T.attached_class)
|
1985
2104
|
end
|
1986
|
-
def self.new(
|
1987
|
-
|
2105
|
+
def self.new(
|
2106
|
+
# Per-event basis point rate
|
2107
|
+
bps:,
|
2108
|
+
# Exclusive tier starting value
|
2109
|
+
minimum_amount:,
|
2110
|
+
# Inclusive tier ending value
|
2111
|
+
maximum_amount: nil,
|
2112
|
+
# Per unit maximum to charge
|
2113
|
+
per_unit_maximum: nil
|
2114
|
+
); end
|
1988
2115
|
sig do
|
1989
2116
|
override
|
1990
2117
|
.returns(
|
@@ -2022,8 +2149,12 @@ module Orb
|
|
2022
2149
|
)
|
2023
2150
|
.returns(T.attached_class)
|
2024
2151
|
end
|
2025
|
-
def self.new(
|
2026
|
-
|
2152
|
+
def self.new(
|
2153
|
+
# The duration of the billing period.
|
2154
|
+
duration:,
|
2155
|
+
# The unit of billing period duration.
|
2156
|
+
duration_unit:
|
2157
|
+
); end
|
2027
2158
|
sig do
|
2028
2159
|
override
|
2029
2160
|
.returns(
|
@@ -2043,14 +2174,7 @@ module Orb
|
|
2043
2174
|
T.type_alias do
|
2044
2175
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit)
|
2045
2176
|
end
|
2046
|
-
OrSymbol =
|
2047
|
-
T.type_alias do
|
2048
|
-
T.any(
|
2049
|
-
Symbol,
|
2050
|
-
String,
|
2051
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
2052
|
-
)
|
2053
|
-
end
|
2177
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2054
2178
|
|
2055
2179
|
DAY =
|
2056
2180
|
T.let(
|
@@ -2097,8 +2221,12 @@ module Orb
|
|
2097
2221
|
)
|
2098
2222
|
.returns(T.attached_class)
|
2099
2223
|
end
|
2100
|
-
def self.new(
|
2101
|
-
|
2224
|
+
def self.new(
|
2225
|
+
# The duration of the billing period.
|
2226
|
+
duration:,
|
2227
|
+
# The unit of billing period duration.
|
2228
|
+
duration_unit:
|
2229
|
+
); end
|
2102
2230
|
sig do
|
2103
2231
|
override
|
2104
2232
|
.returns(
|
@@ -2118,14 +2246,7 @@ module Orb
|
|
2118
2246
|
T.type_alias do
|
2119
2247
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit)
|
2120
2248
|
end
|
2121
|
-
OrSymbol =
|
2122
|
-
T.type_alias do
|
2123
|
-
T.any(
|
2124
|
-
Symbol,
|
2125
|
-
String,
|
2126
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
2127
|
-
)
|
2128
|
-
end
|
2249
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2129
2250
|
|
2130
2251
|
DAY =
|
2131
2252
|
T.let(
|
@@ -2284,18 +2405,39 @@ module Orb
|
|
2284
2405
|
end
|
2285
2406
|
def self.new(
|
2286
2407
|
bps_config:,
|
2408
|
+
# The cadence to bill for this price on.
|
2287
2409
|
cadence:,
|
2410
|
+
# The id of the item the price will be associated with.
|
2288
2411
|
item_id:,
|
2412
|
+
# The name of the price.
|
2289
2413
|
name:,
|
2414
|
+
# The id of the billable metric for the price. Only needed if the price is
|
2415
|
+
# usage-based.
|
2290
2416
|
billable_metric_id: nil,
|
2417
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
2418
|
+
# this is true, and in-arrears if this is false.
|
2291
2419
|
billed_in_advance: nil,
|
2420
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
2421
|
+
# months.
|
2292
2422
|
billing_cycle_configuration: nil,
|
2423
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
2293
2424
|
conversion_rate: nil,
|
2425
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
2426
|
+
# price is billed.
|
2294
2427
|
currency: nil,
|
2428
|
+
# An alias for the price.
|
2295
2429
|
external_price_id: nil,
|
2430
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
2431
|
+
# applied.
|
2296
2432
|
fixed_price_quantity: nil,
|
2433
|
+
# The property used to group this price on an invoice
|
2297
2434
|
invoice_grouping_key: nil,
|
2435
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2436
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2298
2437
|
invoicing_cycle_configuration: nil,
|
2438
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
2439
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
2440
|
+
# by setting `metadata` to `null`.
|
2299
2441
|
metadata: nil,
|
2300
2442
|
model_type: :bps
|
2301
2443
|
); end
|
@@ -2333,8 +2475,12 @@ module Orb
|
|
2333
2475
|
attr_accessor :per_unit_maximum
|
2334
2476
|
|
2335
2477
|
sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) }
|
2336
|
-
def self.new(
|
2337
|
-
|
2478
|
+
def self.new(
|
2479
|
+
# Basis point take rate per event
|
2480
|
+
bps:,
|
2481
|
+
# Optional currency amount maximum to cap spend per event
|
2482
|
+
per_unit_maximum: nil
|
2483
|
+
); end
|
2338
2484
|
sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) }
|
2339
2485
|
def to_hash; end
|
2340
2486
|
end
|
@@ -2345,8 +2491,7 @@ module Orb
|
|
2345
2491
|
|
2346
2492
|
TaggedSymbol =
|
2347
2493
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence) }
|
2348
|
-
OrSymbol =
|
2349
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence::TaggedSymbol) }
|
2494
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2350
2495
|
|
2351
2496
|
ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::Cadence::TaggedSymbol)
|
2352
2497
|
SEMI_ANNUAL =
|
@@ -2383,8 +2528,12 @@ module Orb
|
|
2383
2528
|
)
|
2384
2529
|
.returns(T.attached_class)
|
2385
2530
|
end
|
2386
|
-
def self.new(
|
2387
|
-
|
2531
|
+
def self.new(
|
2532
|
+
# The duration of the billing period.
|
2533
|
+
duration:,
|
2534
|
+
# The unit of billing period duration.
|
2535
|
+
duration_unit:
|
2536
|
+
); end
|
2388
2537
|
sig do
|
2389
2538
|
override
|
2390
2539
|
.returns(
|
@@ -2404,14 +2553,7 @@ module Orb
|
|
2404
2553
|
T.type_alias do
|
2405
2554
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit)
|
2406
2555
|
end
|
2407
|
-
OrSymbol =
|
2408
|
-
T.type_alias do
|
2409
|
-
T.any(
|
2410
|
-
Symbol,
|
2411
|
-
String,
|
2412
|
-
Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
2413
|
-
)
|
2414
|
-
end
|
2556
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2415
2557
|
|
2416
2558
|
DAY =
|
2417
2559
|
T.let(
|
@@ -2458,8 +2600,12 @@ module Orb
|
|
2458
2600
|
)
|
2459
2601
|
.returns(T.attached_class)
|
2460
2602
|
end
|
2461
|
-
def self.new(
|
2462
|
-
|
2603
|
+
def self.new(
|
2604
|
+
# The duration of the billing period.
|
2605
|
+
duration:,
|
2606
|
+
# The unit of billing period duration.
|
2607
|
+
duration_unit:
|
2608
|
+
); end
|
2463
2609
|
sig do
|
2464
2610
|
override
|
2465
2611
|
.returns(
|
@@ -2479,14 +2625,7 @@ module Orb
|
|
2479
2625
|
T.type_alias do
|
2480
2626
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit)
|
2481
2627
|
end
|
2482
|
-
OrSymbol =
|
2483
|
-
T.type_alias do
|
2484
|
-
T.any(
|
2485
|
-
Symbol,
|
2486
|
-
String,
|
2487
|
-
Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
2488
|
-
)
|
2489
|
-
end
|
2628
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2490
2629
|
|
2491
2630
|
DAY =
|
2492
2631
|
T.let(
|
@@ -2645,18 +2784,39 @@ module Orb
|
|
2645
2784
|
end
|
2646
2785
|
def self.new(
|
2647
2786
|
bulk_bps_config:,
|
2787
|
+
# The cadence to bill for this price on.
|
2648
2788
|
cadence:,
|
2789
|
+
# The id of the item the price will be associated with.
|
2649
2790
|
item_id:,
|
2791
|
+
# The name of the price.
|
2650
2792
|
name:,
|
2793
|
+
# The id of the billable metric for the price. Only needed if the price is
|
2794
|
+
# usage-based.
|
2651
2795
|
billable_metric_id: nil,
|
2796
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
2797
|
+
# this is true, and in-arrears if this is false.
|
2652
2798
|
billed_in_advance: nil,
|
2799
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
2800
|
+
# months.
|
2653
2801
|
billing_cycle_configuration: nil,
|
2802
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
2654
2803
|
conversion_rate: nil,
|
2804
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
2805
|
+
# price is billed.
|
2655
2806
|
currency: nil,
|
2807
|
+
# An alias for the price.
|
2656
2808
|
external_price_id: nil,
|
2809
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
2810
|
+
# applied.
|
2657
2811
|
fixed_price_quantity: nil,
|
2812
|
+
# The property used to group this price on an invoice
|
2658
2813
|
invoice_grouping_key: nil,
|
2814
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2815
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
2659
2816
|
invoicing_cycle_configuration: nil,
|
2817
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
2818
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
2819
|
+
# by setting `metadata` to `null`.
|
2660
2820
|
metadata: nil,
|
2661
2821
|
model_type: :bulk_bps
|
2662
2822
|
); end
|
@@ -2701,8 +2861,11 @@ module Orb
|
|
2701
2861
|
)
|
2702
2862
|
.returns(T.attached_class)
|
2703
2863
|
end
|
2704
|
-
def self.new(
|
2705
|
-
|
2864
|
+
def self.new(
|
2865
|
+
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
2866
|
+
# tier based on total volume
|
2867
|
+
tiers:
|
2868
|
+
); end
|
2706
2869
|
sig do
|
2707
2870
|
override
|
2708
2871
|
.returns({tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier]})
|
@@ -2726,8 +2889,14 @@ module Orb
|
|
2726
2889
|
params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String))
|
2727
2890
|
.returns(T.attached_class)
|
2728
2891
|
end
|
2729
|
-
def self.new(
|
2730
|
-
|
2892
|
+
def self.new(
|
2893
|
+
# Basis points to rate on
|
2894
|
+
bps:,
|
2895
|
+
# Upper bound for tier
|
2896
|
+
maximum_amount: nil,
|
2897
|
+
# The maximum amount to charge for any one event
|
2898
|
+
per_unit_maximum: nil
|
2899
|
+
); end
|
2731
2900
|
sig do
|
2732
2901
|
override.returns(
|
2733
2902
|
{
|
@@ -2747,8 +2916,7 @@ module Orb
|
|
2747
2916
|
|
2748
2917
|
TaggedSymbol =
|
2749
2918
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence) }
|
2750
|
-
OrSymbol =
|
2751
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence::TaggedSymbol) }
|
2919
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2752
2920
|
|
2753
2921
|
ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::Cadence::TaggedSymbol)
|
2754
2922
|
SEMI_ANNUAL =
|
@@ -2790,8 +2958,12 @@ module Orb
|
|
2790
2958
|
)
|
2791
2959
|
.returns(T.attached_class)
|
2792
2960
|
end
|
2793
|
-
def self.new(
|
2794
|
-
|
2961
|
+
def self.new(
|
2962
|
+
# The duration of the billing period.
|
2963
|
+
duration:,
|
2964
|
+
# The unit of billing period duration.
|
2965
|
+
duration_unit:
|
2966
|
+
); end
|
2795
2967
|
sig do
|
2796
2968
|
override
|
2797
2969
|
.returns(
|
@@ -2811,14 +2983,7 @@ module Orb
|
|
2811
2983
|
T.type_alias do
|
2812
2984
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit)
|
2813
2985
|
end
|
2814
|
-
OrSymbol =
|
2815
|
-
T.type_alias do
|
2816
|
-
T.any(
|
2817
|
-
Symbol,
|
2818
|
-
String,
|
2819
|
-
Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
2820
|
-
)
|
2821
|
-
end
|
2986
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2822
2987
|
|
2823
2988
|
DAY =
|
2824
2989
|
T.let(
|
@@ -2865,8 +3030,12 @@ module Orb
|
|
2865
3030
|
)
|
2866
3031
|
.returns(T.attached_class)
|
2867
3032
|
end
|
2868
|
-
def self.new(
|
2869
|
-
|
3033
|
+
def self.new(
|
3034
|
+
# The duration of the billing period.
|
3035
|
+
duration:,
|
3036
|
+
# The unit of billing period duration.
|
3037
|
+
duration_unit:
|
3038
|
+
); end
|
2870
3039
|
sig do
|
2871
3040
|
override
|
2872
3041
|
.returns(
|
@@ -2886,14 +3055,7 @@ module Orb
|
|
2886
3055
|
T.type_alias do
|
2887
3056
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit)
|
2888
3057
|
end
|
2889
|
-
OrSymbol =
|
2890
|
-
T.type_alias do
|
2891
|
-
T.any(
|
2892
|
-
Symbol,
|
2893
|
-
String,
|
2894
|
-
Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
2895
|
-
)
|
2896
|
-
end
|
3058
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
2897
3059
|
|
2898
3060
|
DAY =
|
2899
3061
|
T.let(
|
@@ -3052,18 +3214,39 @@ module Orb
|
|
3052
3214
|
end
|
3053
3215
|
def self.new(
|
3054
3216
|
bulk_config:,
|
3217
|
+
# The cadence to bill for this price on.
|
3055
3218
|
cadence:,
|
3219
|
+
# The id of the item the price will be associated with.
|
3056
3220
|
item_id:,
|
3221
|
+
# The name of the price.
|
3057
3222
|
name:,
|
3223
|
+
# The id of the billable metric for the price. Only needed if the price is
|
3224
|
+
# usage-based.
|
3058
3225
|
billable_metric_id: nil,
|
3226
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
3227
|
+
# this is true, and in-arrears if this is false.
|
3059
3228
|
billed_in_advance: nil,
|
3229
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
3230
|
+
# months.
|
3060
3231
|
billing_cycle_configuration: nil,
|
3232
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
3061
3233
|
conversion_rate: nil,
|
3234
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
3235
|
+
# price is billed.
|
3062
3236
|
currency: nil,
|
3237
|
+
# An alias for the price.
|
3063
3238
|
external_price_id: nil,
|
3239
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
3240
|
+
# applied.
|
3064
3241
|
fixed_price_quantity: nil,
|
3242
|
+
# The property used to group this price on an invoice
|
3065
3243
|
invoice_grouping_key: nil,
|
3244
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3245
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3066
3246
|
invoicing_cycle_configuration: nil,
|
3247
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
3248
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
3249
|
+
# by setting `metadata` to `null`.
|
3067
3250
|
metadata: nil,
|
3068
3251
|
model_type: :bulk
|
3069
3252
|
); end
|
@@ -3102,8 +3285,10 @@ module Orb
|
|
3102
3285
|
)
|
3103
3286
|
.returns(T.attached_class)
|
3104
3287
|
end
|
3105
|
-
def self.new(
|
3106
|
-
|
3288
|
+
def self.new(
|
3289
|
+
# Bulk tiers for rating based on total usage volume
|
3290
|
+
tiers:
|
3291
|
+
); end
|
3107
3292
|
sig do
|
3108
3293
|
override
|
3109
3294
|
.returns({tiers: T::Array[Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BulkConfig::Tier]})
|
@@ -3120,8 +3305,12 @@ module Orb
|
|
3120
3305
|
attr_accessor :maximum_units
|
3121
3306
|
|
3122
3307
|
sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) }
|
3123
|
-
def self.new(
|
3124
|
-
|
3308
|
+
def self.new(
|
3309
|
+
# Amount per unit
|
3310
|
+
unit_amount:,
|
3311
|
+
# Upper bound for this tier
|
3312
|
+
maximum_units: nil
|
3313
|
+
); end
|
3125
3314
|
sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) }
|
3126
3315
|
def to_hash; end
|
3127
3316
|
end
|
@@ -3133,8 +3322,7 @@ module Orb
|
|
3133
3322
|
|
3134
3323
|
TaggedSymbol =
|
3135
3324
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence) }
|
3136
|
-
OrSymbol =
|
3137
|
-
T.type_alias { T.any(Symbol, String, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence::TaggedSymbol) }
|
3325
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3138
3326
|
|
3139
3327
|
ANNUAL = T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::Cadence::TaggedSymbol)
|
3140
3328
|
SEMI_ANNUAL =
|
@@ -3172,8 +3360,12 @@ module Orb
|
|
3172
3360
|
)
|
3173
3361
|
.returns(T.attached_class)
|
3174
3362
|
end
|
3175
|
-
def self.new(
|
3176
|
-
|
3363
|
+
def self.new(
|
3364
|
+
# The duration of the billing period.
|
3365
|
+
duration:,
|
3366
|
+
# The unit of billing period duration.
|
3367
|
+
duration_unit:
|
3368
|
+
); end
|
3177
3369
|
sig do
|
3178
3370
|
override
|
3179
3371
|
.returns(
|
@@ -3193,14 +3385,7 @@ module Orb
|
|
3193
3385
|
T.type_alias do
|
3194
3386
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit)
|
3195
3387
|
end
|
3196
|
-
OrSymbol =
|
3197
|
-
T.type_alias do
|
3198
|
-
T.any(
|
3199
|
-
Symbol,
|
3200
|
-
String,
|
3201
|
-
Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
3202
|
-
)
|
3203
|
-
end
|
3388
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3204
3389
|
|
3205
3390
|
DAY =
|
3206
3391
|
T.let(
|
@@ -3247,8 +3432,12 @@ module Orb
|
|
3247
3432
|
)
|
3248
3433
|
.returns(T.attached_class)
|
3249
3434
|
end
|
3250
|
-
def self.new(
|
3251
|
-
|
3435
|
+
def self.new(
|
3436
|
+
# The duration of the billing period.
|
3437
|
+
duration:,
|
3438
|
+
# The unit of billing period duration.
|
3439
|
+
duration_unit:
|
3440
|
+
); end
|
3252
3441
|
sig do
|
3253
3442
|
override
|
3254
3443
|
.returns(
|
@@ -3268,14 +3457,7 @@ module Orb
|
|
3268
3457
|
T.type_alias do
|
3269
3458
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit)
|
3270
3459
|
end
|
3271
|
-
OrSymbol =
|
3272
|
-
T.type_alias do
|
3273
|
-
T.any(
|
3274
|
-
Symbol,
|
3275
|
-
String,
|
3276
|
-
Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
3277
|
-
)
|
3278
|
-
end
|
3460
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3279
3461
|
|
3280
3462
|
DAY =
|
3281
3463
|
T.let(
|
@@ -3437,19 +3619,40 @@ module Orb
|
|
3437
3619
|
.returns(T.attached_class)
|
3438
3620
|
end
|
3439
3621
|
def self.new(
|
3622
|
+
# The cadence to bill for this price on.
|
3440
3623
|
cadence:,
|
3624
|
+
# The id of the item the price will be associated with.
|
3441
3625
|
item_id:,
|
3626
|
+
# The name of the price.
|
3442
3627
|
name:,
|
3443
3628
|
threshold_total_amount_config:,
|
3629
|
+
# The id of the billable metric for the price. Only needed if the price is
|
3630
|
+
# usage-based.
|
3444
3631
|
billable_metric_id: nil,
|
3632
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
3633
|
+
# this is true, and in-arrears if this is false.
|
3445
3634
|
billed_in_advance: nil,
|
3635
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
3636
|
+
# months.
|
3446
3637
|
billing_cycle_configuration: nil,
|
3638
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
3447
3639
|
conversion_rate: nil,
|
3640
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
3641
|
+
# price is billed.
|
3448
3642
|
currency: nil,
|
3643
|
+
# An alias for the price.
|
3449
3644
|
external_price_id: nil,
|
3645
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
3646
|
+
# applied.
|
3450
3647
|
fixed_price_quantity: nil,
|
3648
|
+
# The property used to group this price on an invoice
|
3451
3649
|
invoice_grouping_key: nil,
|
3650
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3651
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3452
3652
|
invoicing_cycle_configuration: nil,
|
3653
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
3654
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
3655
|
+
# by setting `metadata` to `null`.
|
3453
3656
|
metadata: nil,
|
3454
3657
|
model_type: :threshold_total_amount
|
3455
3658
|
); end
|
@@ -3487,14 +3690,7 @@ module Orb
|
|
3487
3690
|
|
3488
3691
|
TaggedSymbol =
|
3489
3692
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence) }
|
3490
|
-
OrSymbol =
|
3491
|
-
T.type_alias do
|
3492
|
-
T.any(
|
3493
|
-
Symbol,
|
3494
|
-
String,
|
3495
|
-
Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::Cadence::TaggedSymbol
|
3496
|
-
)
|
3497
|
-
end
|
3693
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3498
3694
|
|
3499
3695
|
ANNUAL =
|
3500
3696
|
T.let(
|
@@ -3558,8 +3754,12 @@ module Orb
|
|
3558
3754
|
)
|
3559
3755
|
.returns(T.attached_class)
|
3560
3756
|
end
|
3561
|
-
def self.new(
|
3562
|
-
|
3757
|
+
def self.new(
|
3758
|
+
# The duration of the billing period.
|
3759
|
+
duration:,
|
3760
|
+
# The unit of billing period duration.
|
3761
|
+
duration_unit:
|
3762
|
+
); end
|
3563
3763
|
sig do
|
3564
3764
|
override
|
3565
3765
|
.returns(
|
@@ -3579,14 +3779,7 @@ module Orb
|
|
3579
3779
|
T.type_alias do
|
3580
3780
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit)
|
3581
3781
|
end
|
3582
|
-
OrSymbol =
|
3583
|
-
T.type_alias do
|
3584
|
-
T.any(
|
3585
|
-
Symbol,
|
3586
|
-
String,
|
3587
|
-
Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
3588
|
-
)
|
3589
|
-
end
|
3782
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3590
3783
|
|
3591
3784
|
DAY =
|
3592
3785
|
T.let(
|
@@ -3633,8 +3826,12 @@ module Orb
|
|
3633
3826
|
)
|
3634
3827
|
.returns(T.attached_class)
|
3635
3828
|
end
|
3636
|
-
def self.new(
|
3637
|
-
|
3829
|
+
def self.new(
|
3830
|
+
# The duration of the billing period.
|
3831
|
+
duration:,
|
3832
|
+
# The unit of billing period duration.
|
3833
|
+
duration_unit:
|
3834
|
+
); end
|
3638
3835
|
sig do
|
3639
3836
|
override
|
3640
3837
|
.returns(
|
@@ -3654,14 +3851,7 @@ module Orb
|
|
3654
3851
|
T.type_alias do
|
3655
3852
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit)
|
3656
3853
|
end
|
3657
|
-
OrSymbol =
|
3658
|
-
T.type_alias do
|
3659
|
-
T.any(
|
3660
|
-
Symbol,
|
3661
|
-
String,
|
3662
|
-
Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
3663
|
-
)
|
3664
|
-
end
|
3854
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3665
3855
|
|
3666
3856
|
DAY =
|
3667
3857
|
T.let(
|
@@ -3819,19 +4009,40 @@ module Orb
|
|
3819
4009
|
.returns(T.attached_class)
|
3820
4010
|
end
|
3821
4011
|
def self.new(
|
4012
|
+
# The cadence to bill for this price on.
|
3822
4013
|
cadence:,
|
4014
|
+
# The id of the item the price will be associated with.
|
3823
4015
|
item_id:,
|
4016
|
+
# The name of the price.
|
3824
4017
|
name:,
|
3825
4018
|
tiered_package_config:,
|
4019
|
+
# The id of the billable metric for the price. Only needed if the price is
|
4020
|
+
# usage-based.
|
3826
4021
|
billable_metric_id: nil,
|
4022
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
4023
|
+
# this is true, and in-arrears if this is false.
|
3827
4024
|
billed_in_advance: nil,
|
4025
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
4026
|
+
# months.
|
3828
4027
|
billing_cycle_configuration: nil,
|
4028
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
3829
4029
|
conversion_rate: nil,
|
4030
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
4031
|
+
# price is billed.
|
3830
4032
|
currency: nil,
|
4033
|
+
# An alias for the price.
|
3831
4034
|
external_price_id: nil,
|
4035
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
4036
|
+
# applied.
|
3832
4037
|
fixed_price_quantity: nil,
|
4038
|
+
# The property used to group this price on an invoice
|
3833
4039
|
invoice_grouping_key: nil,
|
4040
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4041
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
3834
4042
|
invoicing_cycle_configuration: nil,
|
4043
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
4044
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
4045
|
+
# by setting `metadata` to `null`.
|
3835
4046
|
metadata: nil,
|
3836
4047
|
model_type: :tiered_package
|
3837
4048
|
); end
|
@@ -3865,14 +4076,7 @@ module Orb
|
|
3865
4076
|
|
3866
4077
|
TaggedSymbol =
|
3867
4078
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence) }
|
3868
|
-
OrSymbol =
|
3869
|
-
T.type_alias do
|
3870
|
-
T.any(
|
3871
|
-
Symbol,
|
3872
|
-
String,
|
3873
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence::TaggedSymbol
|
3874
|
-
)
|
3875
|
-
end
|
4079
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3876
4080
|
|
3877
4081
|
ANNUAL =
|
3878
4082
|
T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::Cadence::TaggedSymbol)
|
@@ -3919,8 +4123,12 @@ module Orb
|
|
3919
4123
|
)
|
3920
4124
|
.returns(T.attached_class)
|
3921
4125
|
end
|
3922
|
-
def self.new(
|
3923
|
-
|
4126
|
+
def self.new(
|
4127
|
+
# The duration of the billing period.
|
4128
|
+
duration:,
|
4129
|
+
# The unit of billing period duration.
|
4130
|
+
duration_unit:
|
4131
|
+
); end
|
3924
4132
|
sig do
|
3925
4133
|
override
|
3926
4134
|
.returns(
|
@@ -3940,14 +4148,7 @@ module Orb
|
|
3940
4148
|
T.type_alias do
|
3941
4149
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit)
|
3942
4150
|
end
|
3943
|
-
OrSymbol =
|
3944
|
-
T.type_alias do
|
3945
|
-
T.any(
|
3946
|
-
Symbol,
|
3947
|
-
String,
|
3948
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
3949
|
-
)
|
3950
|
-
end
|
4151
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
3951
4152
|
|
3952
4153
|
DAY =
|
3953
4154
|
T.let(
|
@@ -3994,8 +4195,12 @@ module Orb
|
|
3994
4195
|
)
|
3995
4196
|
.returns(T.attached_class)
|
3996
4197
|
end
|
3997
|
-
def self.new(
|
3998
|
-
|
4198
|
+
def self.new(
|
4199
|
+
# The duration of the billing period.
|
4200
|
+
duration:,
|
4201
|
+
# The unit of billing period duration.
|
4202
|
+
duration_unit:
|
4203
|
+
); end
|
3999
4204
|
sig do
|
4000
4205
|
override
|
4001
4206
|
.returns(
|
@@ -4015,14 +4220,7 @@ module Orb
|
|
4015
4220
|
T.type_alias do
|
4016
4221
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit)
|
4017
4222
|
end
|
4018
|
-
OrSymbol =
|
4019
|
-
T.type_alias do
|
4020
|
-
T.any(
|
4021
|
-
Symbol,
|
4022
|
-
String,
|
4023
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
4024
|
-
)
|
4025
|
-
end
|
4223
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4026
4224
|
|
4027
4225
|
DAY =
|
4028
4226
|
T.let(
|
@@ -4182,19 +4380,40 @@ module Orb
|
|
4182
4380
|
.returns(T.attached_class)
|
4183
4381
|
end
|
4184
4382
|
def self.new(
|
4383
|
+
# The cadence to bill for this price on.
|
4185
4384
|
cadence:,
|
4385
|
+
# The id of the item the price will be associated with.
|
4186
4386
|
item_id:,
|
4387
|
+
# The name of the price.
|
4187
4388
|
name:,
|
4188
4389
|
tiered_with_minimum_config:,
|
4390
|
+
# The id of the billable metric for the price. Only needed if the price is
|
4391
|
+
# usage-based.
|
4189
4392
|
billable_metric_id: nil,
|
4393
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
4394
|
+
# this is true, and in-arrears if this is false.
|
4190
4395
|
billed_in_advance: nil,
|
4396
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
4397
|
+
# months.
|
4191
4398
|
billing_cycle_configuration: nil,
|
4399
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
4192
4400
|
conversion_rate: nil,
|
4401
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
4402
|
+
# price is billed.
|
4193
4403
|
currency: nil,
|
4404
|
+
# An alias for the price.
|
4194
4405
|
external_price_id: nil,
|
4406
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
4407
|
+
# applied.
|
4195
4408
|
fixed_price_quantity: nil,
|
4409
|
+
# The property used to group this price on an invoice
|
4196
4410
|
invoice_grouping_key: nil,
|
4411
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4412
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4197
4413
|
invoicing_cycle_configuration: nil,
|
4414
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
4415
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
4416
|
+
# by setting `metadata` to `null`.
|
4198
4417
|
metadata: nil,
|
4199
4418
|
model_type: :tiered_with_minimum
|
4200
4419
|
); end
|
@@ -4230,14 +4449,7 @@ module Orb
|
|
4230
4449
|
|
4231
4450
|
TaggedSymbol =
|
4232
4451
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence) }
|
4233
|
-
OrSymbol =
|
4234
|
-
T.type_alias do
|
4235
|
-
T.any(
|
4236
|
-
Symbol,
|
4237
|
-
String,
|
4238
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence::TaggedSymbol
|
4239
|
-
)
|
4240
|
-
end
|
4452
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4241
4453
|
|
4242
4454
|
ANNUAL =
|
4243
4455
|
T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::Cadence::TaggedSymbol)
|
@@ -4295,8 +4507,12 @@ module Orb
|
|
4295
4507
|
)
|
4296
4508
|
.returns(T.attached_class)
|
4297
4509
|
end
|
4298
|
-
def self.new(
|
4299
|
-
|
4510
|
+
def self.new(
|
4511
|
+
# The duration of the billing period.
|
4512
|
+
duration:,
|
4513
|
+
# The unit of billing period duration.
|
4514
|
+
duration_unit:
|
4515
|
+
); end
|
4300
4516
|
sig do
|
4301
4517
|
override
|
4302
4518
|
.returns(
|
@@ -4316,14 +4532,7 @@ module Orb
|
|
4316
4532
|
T.type_alias do
|
4317
4533
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit)
|
4318
4534
|
end
|
4319
|
-
OrSymbol =
|
4320
|
-
T.type_alias do
|
4321
|
-
T.any(
|
4322
|
-
Symbol,
|
4323
|
-
String,
|
4324
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
4325
|
-
)
|
4326
|
-
end
|
4535
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4327
4536
|
|
4328
4537
|
DAY =
|
4329
4538
|
T.let(
|
@@ -4370,8 +4579,12 @@ module Orb
|
|
4370
4579
|
)
|
4371
4580
|
.returns(T.attached_class)
|
4372
4581
|
end
|
4373
|
-
def self.new(
|
4374
|
-
|
4582
|
+
def self.new(
|
4583
|
+
# The duration of the billing period.
|
4584
|
+
duration:,
|
4585
|
+
# The unit of billing period duration.
|
4586
|
+
duration_unit:
|
4587
|
+
); end
|
4375
4588
|
sig do
|
4376
4589
|
override
|
4377
4590
|
.returns(
|
@@ -4391,14 +4604,7 @@ module Orb
|
|
4391
4604
|
T.type_alias do
|
4392
4605
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit)
|
4393
4606
|
end
|
4394
|
-
OrSymbol =
|
4395
|
-
T.type_alias do
|
4396
|
-
T.any(
|
4397
|
-
Symbol,
|
4398
|
-
String,
|
4399
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
4400
|
-
)
|
4401
|
-
end
|
4607
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4402
4608
|
|
4403
4609
|
DAY =
|
4404
4610
|
T.let(
|
@@ -4556,19 +4762,40 @@ module Orb
|
|
4556
4762
|
.returns(T.attached_class)
|
4557
4763
|
end
|
4558
4764
|
def self.new(
|
4765
|
+
# The cadence to bill for this price on.
|
4559
4766
|
cadence:,
|
4767
|
+
# The id of the item the price will be associated with.
|
4560
4768
|
item_id:,
|
4769
|
+
# The name of the price.
|
4561
4770
|
name:,
|
4562
4771
|
unit_with_percent_config:,
|
4772
|
+
# The id of the billable metric for the price. Only needed if the price is
|
4773
|
+
# usage-based.
|
4563
4774
|
billable_metric_id: nil,
|
4775
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
4776
|
+
# this is true, and in-arrears if this is false.
|
4564
4777
|
billed_in_advance: nil,
|
4778
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
4779
|
+
# months.
|
4565
4780
|
billing_cycle_configuration: nil,
|
4781
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
4566
4782
|
conversion_rate: nil,
|
4783
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
4784
|
+
# price is billed.
|
4567
4785
|
currency: nil,
|
4786
|
+
# An alias for the price.
|
4568
4787
|
external_price_id: nil,
|
4788
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
4789
|
+
# applied.
|
4569
4790
|
fixed_price_quantity: nil,
|
4791
|
+
# The property used to group this price on an invoice
|
4570
4792
|
invoice_grouping_key: nil,
|
4793
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4794
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4571
4795
|
invoicing_cycle_configuration: nil,
|
4796
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
4797
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
4798
|
+
# by setting `metadata` to `null`.
|
4572
4799
|
metadata: nil,
|
4573
4800
|
model_type: :unit_with_percent
|
4574
4801
|
); end
|
@@ -4602,14 +4829,7 @@ module Orb
|
|
4602
4829
|
|
4603
4830
|
TaggedSymbol =
|
4604
4831
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence) }
|
4605
|
-
OrSymbol =
|
4606
|
-
T.type_alias do
|
4607
|
-
T.any(
|
4608
|
-
Symbol,
|
4609
|
-
String,
|
4610
|
-
Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence::TaggedSymbol
|
4611
|
-
)
|
4612
|
-
end
|
4832
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4613
4833
|
|
4614
4834
|
ANNUAL =
|
4615
4835
|
T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::Cadence::TaggedSymbol)
|
@@ -4661,8 +4881,12 @@ module Orb
|
|
4661
4881
|
)
|
4662
4882
|
.returns(T.attached_class)
|
4663
4883
|
end
|
4664
|
-
def self.new(
|
4665
|
-
|
4884
|
+
def self.new(
|
4885
|
+
# The duration of the billing period.
|
4886
|
+
duration:,
|
4887
|
+
# The unit of billing period duration.
|
4888
|
+
duration_unit:
|
4889
|
+
); end
|
4666
4890
|
sig do
|
4667
4891
|
override
|
4668
4892
|
.returns(
|
@@ -4682,14 +4906,7 @@ module Orb
|
|
4682
4906
|
T.type_alias do
|
4683
4907
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit)
|
4684
4908
|
end
|
4685
|
-
OrSymbol =
|
4686
|
-
T.type_alias do
|
4687
|
-
T.any(
|
4688
|
-
Symbol,
|
4689
|
-
String,
|
4690
|
-
Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
4691
|
-
)
|
4692
|
-
end
|
4909
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4693
4910
|
|
4694
4911
|
DAY =
|
4695
4912
|
T.let(
|
@@ -4736,8 +4953,12 @@ module Orb
|
|
4736
4953
|
)
|
4737
4954
|
.returns(T.attached_class)
|
4738
4955
|
end
|
4739
|
-
def self.new(
|
4740
|
-
|
4956
|
+
def self.new(
|
4957
|
+
# The duration of the billing period.
|
4958
|
+
duration:,
|
4959
|
+
# The unit of billing period duration.
|
4960
|
+
duration_unit:
|
4961
|
+
); end
|
4741
4962
|
sig do
|
4742
4963
|
override
|
4743
4964
|
.returns(
|
@@ -4757,14 +4978,7 @@ module Orb
|
|
4757
4978
|
T.type_alias do
|
4758
4979
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit)
|
4759
4980
|
end
|
4760
|
-
OrSymbol =
|
4761
|
-
T.type_alias do
|
4762
|
-
T.any(
|
4763
|
-
Symbol,
|
4764
|
-
String,
|
4765
|
-
Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
4766
|
-
)
|
4767
|
-
end
|
4981
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4768
4982
|
|
4769
4983
|
DAY =
|
4770
4984
|
T.let(
|
@@ -4926,19 +5140,40 @@ module Orb
|
|
4926
5140
|
.returns(T.attached_class)
|
4927
5141
|
end
|
4928
5142
|
def self.new(
|
5143
|
+
# The cadence to bill for this price on.
|
4929
5144
|
cadence:,
|
5145
|
+
# The id of the item the price will be associated with.
|
4930
5146
|
item_id:,
|
5147
|
+
# The name of the price.
|
4931
5148
|
name:,
|
4932
5149
|
package_with_allocation_config:,
|
5150
|
+
# The id of the billable metric for the price. Only needed if the price is
|
5151
|
+
# usage-based.
|
4933
5152
|
billable_metric_id: nil,
|
5153
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
5154
|
+
# this is true, and in-arrears if this is false.
|
4934
5155
|
billed_in_advance: nil,
|
5156
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
5157
|
+
# months.
|
4935
5158
|
billing_cycle_configuration: nil,
|
5159
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
4936
5160
|
conversion_rate: nil,
|
5161
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
5162
|
+
# price is billed.
|
4937
5163
|
currency: nil,
|
5164
|
+
# An alias for the price.
|
4938
5165
|
external_price_id: nil,
|
5166
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
5167
|
+
# applied.
|
4939
5168
|
fixed_price_quantity: nil,
|
5169
|
+
# The property used to group this price on an invoice
|
4940
5170
|
invoice_grouping_key: nil,
|
5171
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5172
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
4941
5173
|
invoicing_cycle_configuration: nil,
|
5174
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
5175
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
5176
|
+
# by setting `metadata` to `null`.
|
4942
5177
|
metadata: nil,
|
4943
5178
|
model_type: :package_with_allocation
|
4944
5179
|
); end
|
@@ -4976,14 +5211,7 @@ module Orb
|
|
4976
5211
|
|
4977
5212
|
TaggedSymbol =
|
4978
5213
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence) }
|
4979
|
-
OrSymbol =
|
4980
|
-
T.type_alias do
|
4981
|
-
T.any(
|
4982
|
-
Symbol,
|
4983
|
-
String,
|
4984
|
-
Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::Cadence::TaggedSymbol
|
4985
|
-
)
|
4986
|
-
end
|
5214
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
4987
5215
|
|
4988
5216
|
ANNUAL =
|
4989
5217
|
T.let(
|
@@ -5047,8 +5275,12 @@ module Orb
|
|
5047
5275
|
)
|
5048
5276
|
.returns(T.attached_class)
|
5049
5277
|
end
|
5050
|
-
def self.new(
|
5051
|
-
|
5278
|
+
def self.new(
|
5279
|
+
# The duration of the billing period.
|
5280
|
+
duration:,
|
5281
|
+
# The unit of billing period duration.
|
5282
|
+
duration_unit:
|
5283
|
+
); end
|
5052
5284
|
sig do
|
5053
5285
|
override
|
5054
5286
|
.returns(
|
@@ -5068,14 +5300,7 @@ module Orb
|
|
5068
5300
|
T.type_alias do
|
5069
5301
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit)
|
5070
5302
|
end
|
5071
|
-
OrSymbol =
|
5072
|
-
T.type_alias do
|
5073
|
-
T.any(
|
5074
|
-
Symbol,
|
5075
|
-
String,
|
5076
|
-
Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
5077
|
-
)
|
5078
|
-
end
|
5303
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
5079
5304
|
|
5080
5305
|
DAY =
|
5081
5306
|
T.let(
|
@@ -5122,8 +5347,12 @@ module Orb
|
|
5122
5347
|
)
|
5123
5348
|
.returns(T.attached_class)
|
5124
5349
|
end
|
5125
|
-
def self.new(
|
5126
|
-
|
5350
|
+
def self.new(
|
5351
|
+
# The duration of the billing period.
|
5352
|
+
duration:,
|
5353
|
+
# The unit of billing period duration.
|
5354
|
+
duration_unit:
|
5355
|
+
); end
|
5127
5356
|
sig do
|
5128
5357
|
override
|
5129
5358
|
.returns(
|
@@ -5143,14 +5372,7 @@ module Orb
|
|
5143
5372
|
T.type_alias do
|
5144
5373
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit)
|
5145
5374
|
end
|
5146
|
-
OrSymbol =
|
5147
|
-
T.type_alias do
|
5148
|
-
T.any(
|
5149
|
-
Symbol,
|
5150
|
-
String,
|
5151
|
-
Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
5152
|
-
)
|
5153
|
-
end
|
5375
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
5154
5376
|
|
5155
5377
|
DAY =
|
5156
5378
|
T.let(
|
@@ -5310,19 +5532,40 @@ module Orb
|
|
5310
5532
|
.returns(T.attached_class)
|
5311
5533
|
end
|
5312
5534
|
def self.new(
|
5535
|
+
# The cadence to bill for this price on.
|
5313
5536
|
cadence:,
|
5537
|
+
# The id of the item the price will be associated with.
|
5314
5538
|
item_id:,
|
5539
|
+
# The name of the price.
|
5315
5540
|
name:,
|
5316
5541
|
tiered_with_proration_config:,
|
5542
|
+
# The id of the billable metric for the price. Only needed if the price is
|
5543
|
+
# usage-based.
|
5317
5544
|
billable_metric_id: nil,
|
5545
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
5546
|
+
# this is true, and in-arrears if this is false.
|
5318
5547
|
billed_in_advance: nil,
|
5548
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
5549
|
+
# months.
|
5319
5550
|
billing_cycle_configuration: nil,
|
5551
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
5320
5552
|
conversion_rate: nil,
|
5553
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
5554
|
+
# price is billed.
|
5321
5555
|
currency: nil,
|
5556
|
+
# An alias for the price.
|
5322
5557
|
external_price_id: nil,
|
5558
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
5559
|
+
# applied.
|
5323
5560
|
fixed_price_quantity: nil,
|
5561
|
+
# The property used to group this price on an invoice
|
5324
5562
|
invoice_grouping_key: nil,
|
5563
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5564
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5325
5565
|
invoicing_cycle_configuration: nil,
|
5566
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
5567
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
5568
|
+
# by setting `metadata` to `null`.
|
5326
5569
|
metadata: nil,
|
5327
5570
|
model_type: :tiered_with_proration
|
5328
5571
|
); end
|
@@ -5358,14 +5601,7 @@ module Orb
|
|
5358
5601
|
|
5359
5602
|
TaggedSymbol =
|
5360
5603
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence) }
|
5361
|
-
OrSymbol =
|
5362
|
-
T.type_alias do
|
5363
|
-
T.any(
|
5364
|
-
Symbol,
|
5365
|
-
String,
|
5366
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence::TaggedSymbol
|
5367
|
-
)
|
5368
|
-
end
|
5604
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
5369
5605
|
|
5370
5606
|
ANNUAL =
|
5371
5607
|
T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::Cadence::TaggedSymbol)
|
@@ -5423,8 +5659,12 @@ module Orb
|
|
5423
5659
|
)
|
5424
5660
|
.returns(T.attached_class)
|
5425
5661
|
end
|
5426
|
-
def self.new(
|
5427
|
-
|
5662
|
+
def self.new(
|
5663
|
+
# The duration of the billing period.
|
5664
|
+
duration:,
|
5665
|
+
# The unit of billing period duration.
|
5666
|
+
duration_unit:
|
5667
|
+
); end
|
5428
5668
|
sig do
|
5429
5669
|
override
|
5430
5670
|
.returns(
|
@@ -5444,14 +5684,7 @@ module Orb
|
|
5444
5684
|
T.type_alias do
|
5445
5685
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit)
|
5446
5686
|
end
|
5447
|
-
OrSymbol =
|
5448
|
-
T.type_alias do
|
5449
|
-
T.any(
|
5450
|
-
Symbol,
|
5451
|
-
String,
|
5452
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
5453
|
-
)
|
5454
|
-
end
|
5687
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
5455
5688
|
|
5456
5689
|
DAY =
|
5457
5690
|
T.let(
|
@@ -5498,8 +5731,12 @@ module Orb
|
|
5498
5731
|
)
|
5499
5732
|
.returns(T.attached_class)
|
5500
5733
|
end
|
5501
|
-
def self.new(
|
5502
|
-
|
5734
|
+
def self.new(
|
5735
|
+
# The duration of the billing period.
|
5736
|
+
duration:,
|
5737
|
+
# The unit of billing period duration.
|
5738
|
+
duration_unit:
|
5739
|
+
); end
|
5503
5740
|
sig do
|
5504
5741
|
override
|
5505
5742
|
.returns(
|
@@ -5519,14 +5756,7 @@ module Orb
|
|
5519
5756
|
T.type_alias do
|
5520
5757
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit)
|
5521
5758
|
end
|
5522
|
-
OrSymbol =
|
5523
|
-
T.type_alias do
|
5524
|
-
T.any(
|
5525
|
-
Symbol,
|
5526
|
-
String,
|
5527
|
-
Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
5528
|
-
)
|
5529
|
-
end
|
5759
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
5530
5760
|
|
5531
5761
|
DAY =
|
5532
5762
|
T.let(
|
@@ -5686,19 +5916,40 @@ module Orb
|
|
5686
5916
|
.returns(T.attached_class)
|
5687
5917
|
end
|
5688
5918
|
def self.new(
|
5919
|
+
# The cadence to bill for this price on.
|
5689
5920
|
cadence:,
|
5921
|
+
# The id of the item the price will be associated with.
|
5690
5922
|
item_id:,
|
5923
|
+
# The name of the price.
|
5691
5924
|
name:,
|
5692
5925
|
unit_with_proration_config:,
|
5926
|
+
# The id of the billable metric for the price. Only needed if the price is
|
5927
|
+
# usage-based.
|
5693
5928
|
billable_metric_id: nil,
|
5929
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
5930
|
+
# this is true, and in-arrears if this is false.
|
5694
5931
|
billed_in_advance: nil,
|
5932
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
5933
|
+
# months.
|
5695
5934
|
billing_cycle_configuration: nil,
|
5935
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
5696
5936
|
conversion_rate: nil,
|
5937
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
5938
|
+
# price is billed.
|
5697
5939
|
currency: nil,
|
5940
|
+
# An alias for the price.
|
5698
5941
|
external_price_id: nil,
|
5942
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
5943
|
+
# applied.
|
5699
5944
|
fixed_price_quantity: nil,
|
5945
|
+
# The property used to group this price on an invoice
|
5700
5946
|
invoice_grouping_key: nil,
|
5947
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5948
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
5701
5949
|
invoicing_cycle_configuration: nil,
|
5950
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
5951
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
5952
|
+
# by setting `metadata` to `null`.
|
5702
5953
|
metadata: nil,
|
5703
5954
|
model_type: :unit_with_proration
|
5704
5955
|
); end
|
@@ -5734,14 +5985,7 @@ module Orb
|
|
5734
5985
|
|
5735
5986
|
TaggedSymbol =
|
5736
5987
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence) }
|
5737
|
-
OrSymbol =
|
5738
|
-
T.type_alias do
|
5739
|
-
T.any(
|
5740
|
-
Symbol,
|
5741
|
-
String,
|
5742
|
-
Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence::TaggedSymbol
|
5743
|
-
)
|
5744
|
-
end
|
5988
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
5745
5989
|
|
5746
5990
|
ANNUAL =
|
5747
5991
|
T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::Cadence::TaggedSymbol)
|
@@ -5799,8 +6043,12 @@ module Orb
|
|
5799
6043
|
)
|
5800
6044
|
.returns(T.attached_class)
|
5801
6045
|
end
|
5802
|
-
def self.new(
|
5803
|
-
|
6046
|
+
def self.new(
|
6047
|
+
# The duration of the billing period.
|
6048
|
+
duration:,
|
6049
|
+
# The unit of billing period duration.
|
6050
|
+
duration_unit:
|
6051
|
+
); end
|
5804
6052
|
sig do
|
5805
6053
|
override
|
5806
6054
|
.returns(
|
@@ -5820,14 +6068,7 @@ module Orb
|
|
5820
6068
|
T.type_alias do
|
5821
6069
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit)
|
5822
6070
|
end
|
5823
|
-
OrSymbol =
|
5824
|
-
T.type_alias do
|
5825
|
-
T.any(
|
5826
|
-
Symbol,
|
5827
|
-
String,
|
5828
|
-
Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
5829
|
-
)
|
5830
|
-
end
|
6071
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
5831
6072
|
|
5832
6073
|
DAY =
|
5833
6074
|
T.let(
|
@@ -5874,8 +6115,12 @@ module Orb
|
|
5874
6115
|
)
|
5875
6116
|
.returns(T.attached_class)
|
5876
6117
|
end
|
5877
|
-
def self.new(
|
5878
|
-
|
6118
|
+
def self.new(
|
6119
|
+
# The duration of the billing period.
|
6120
|
+
duration:,
|
6121
|
+
# The unit of billing period duration.
|
6122
|
+
duration_unit:
|
6123
|
+
); end
|
5879
6124
|
sig do
|
5880
6125
|
override
|
5881
6126
|
.returns(
|
@@ -5895,14 +6140,7 @@ module Orb
|
|
5895
6140
|
T.type_alias do
|
5896
6141
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit)
|
5897
6142
|
end
|
5898
|
-
OrSymbol =
|
5899
|
-
T.type_alias do
|
5900
|
-
T.any(
|
5901
|
-
Symbol,
|
5902
|
-
String,
|
5903
|
-
Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
5904
|
-
)
|
5905
|
-
end
|
6143
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
5906
6144
|
|
5907
6145
|
DAY =
|
5908
6146
|
T.let(
|
@@ -6062,19 +6300,40 @@ module Orb
|
|
6062
6300
|
.returns(T.attached_class)
|
6063
6301
|
end
|
6064
6302
|
def self.new(
|
6303
|
+
# The cadence to bill for this price on.
|
6065
6304
|
cadence:,
|
6066
6305
|
grouped_allocation_config:,
|
6306
|
+
# The id of the item the price will be associated with.
|
6067
6307
|
item_id:,
|
6308
|
+
# The name of the price.
|
6068
6309
|
name:,
|
6310
|
+
# The id of the billable metric for the price. Only needed if the price is
|
6311
|
+
# usage-based.
|
6069
6312
|
billable_metric_id: nil,
|
6313
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
6314
|
+
# this is true, and in-arrears if this is false.
|
6070
6315
|
billed_in_advance: nil,
|
6316
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
6317
|
+
# months.
|
6071
6318
|
billing_cycle_configuration: nil,
|
6319
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
6072
6320
|
conversion_rate: nil,
|
6321
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
6322
|
+
# price is billed.
|
6073
6323
|
currency: nil,
|
6324
|
+
# An alias for the price.
|
6074
6325
|
external_price_id: nil,
|
6326
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
6327
|
+
# applied.
|
6075
6328
|
fixed_price_quantity: nil,
|
6329
|
+
# The property used to group this price on an invoice
|
6076
6330
|
invoice_grouping_key: nil,
|
6331
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6332
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
6077
6333
|
invoicing_cycle_configuration: nil,
|
6334
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
6335
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
6336
|
+
# by setting `metadata` to `null`.
|
6078
6337
|
metadata: nil,
|
6079
6338
|
model_type: :grouped_allocation
|
6080
6339
|
); end
|
@@ -6110,14 +6369,7 @@ module Orb
|
|
6110
6369
|
|
6111
6370
|
TaggedSymbol =
|
6112
6371
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence) }
|
6113
|
-
OrSymbol =
|
6114
|
-
T.type_alias do
|
6115
|
-
T.any(
|
6116
|
-
Symbol,
|
6117
|
-
String,
|
6118
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence::TaggedSymbol
|
6119
|
-
)
|
6120
|
-
end
|
6372
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
6121
6373
|
|
6122
6374
|
ANNUAL =
|
6123
6375
|
T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::Cadence::TaggedSymbol)
|
@@ -6175,8 +6427,12 @@ module Orb
|
|
6175
6427
|
)
|
6176
6428
|
.returns(T.attached_class)
|
6177
6429
|
end
|
6178
|
-
def self.new(
|
6179
|
-
|
6430
|
+
def self.new(
|
6431
|
+
# The duration of the billing period.
|
6432
|
+
duration:,
|
6433
|
+
# The unit of billing period duration.
|
6434
|
+
duration_unit:
|
6435
|
+
); end
|
6180
6436
|
sig do
|
6181
6437
|
override
|
6182
6438
|
.returns(
|
@@ -6196,14 +6452,7 @@ module Orb
|
|
6196
6452
|
T.type_alias do
|
6197
6453
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit)
|
6198
6454
|
end
|
6199
|
-
OrSymbol =
|
6200
|
-
T.type_alias do
|
6201
|
-
T.any(
|
6202
|
-
Symbol,
|
6203
|
-
String,
|
6204
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
6205
|
-
)
|
6206
|
-
end
|
6455
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
6207
6456
|
|
6208
6457
|
DAY =
|
6209
6458
|
T.let(
|
@@ -6250,8 +6499,12 @@ module Orb
|
|
6250
6499
|
)
|
6251
6500
|
.returns(T.attached_class)
|
6252
6501
|
end
|
6253
|
-
def self.new(
|
6254
|
-
|
6502
|
+
def self.new(
|
6503
|
+
# The duration of the billing period.
|
6504
|
+
duration:,
|
6505
|
+
# The unit of billing period duration.
|
6506
|
+
duration_unit:
|
6507
|
+
); end
|
6255
6508
|
sig do
|
6256
6509
|
override
|
6257
6510
|
.returns(
|
@@ -6271,14 +6524,7 @@ module Orb
|
|
6271
6524
|
T.type_alias do
|
6272
6525
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit)
|
6273
6526
|
end
|
6274
|
-
OrSymbol =
|
6275
|
-
T.type_alias do
|
6276
|
-
T.any(
|
6277
|
-
Symbol,
|
6278
|
-
String,
|
6279
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
6280
|
-
)
|
6281
|
-
end
|
6527
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
6282
6528
|
|
6283
6529
|
DAY =
|
6284
6530
|
T.let(
|
@@ -6440,19 +6686,40 @@ module Orb
|
|
6440
6686
|
.returns(T.attached_class)
|
6441
6687
|
end
|
6442
6688
|
def self.new(
|
6689
|
+
# The cadence to bill for this price on.
|
6443
6690
|
cadence:,
|
6444
6691
|
grouped_with_prorated_minimum_config:,
|
6692
|
+
# The id of the item the price will be associated with.
|
6445
6693
|
item_id:,
|
6694
|
+
# The name of the price.
|
6446
6695
|
name:,
|
6696
|
+
# The id of the billable metric for the price. Only needed if the price is
|
6697
|
+
# usage-based.
|
6447
6698
|
billable_metric_id: nil,
|
6699
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
6700
|
+
# this is true, and in-arrears if this is false.
|
6448
6701
|
billed_in_advance: nil,
|
6702
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
6703
|
+
# months.
|
6449
6704
|
billing_cycle_configuration: nil,
|
6705
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
6450
6706
|
conversion_rate: nil,
|
6707
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
6708
|
+
# price is billed.
|
6451
6709
|
currency: nil,
|
6710
|
+
# An alias for the price.
|
6452
6711
|
external_price_id: nil,
|
6712
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
6713
|
+
# applied.
|
6453
6714
|
fixed_price_quantity: nil,
|
6715
|
+
# The property used to group this price on an invoice
|
6454
6716
|
invoice_grouping_key: nil,
|
6717
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6718
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
6455
6719
|
invoicing_cycle_configuration: nil,
|
6720
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
6721
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
6722
|
+
# by setting `metadata` to `null`.
|
6456
6723
|
metadata: nil,
|
6457
6724
|
model_type: :grouped_with_prorated_minimum
|
6458
6725
|
); end
|
@@ -6490,14 +6757,7 @@ module Orb
|
|
6490
6757
|
|
6491
6758
|
TaggedSymbol =
|
6492
6759
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence) }
|
6493
|
-
OrSymbol =
|
6494
|
-
T.type_alias do
|
6495
|
-
T.any(
|
6496
|
-
Symbol,
|
6497
|
-
String,
|
6498
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol
|
6499
|
-
)
|
6500
|
-
end
|
6760
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
6501
6761
|
|
6502
6762
|
ANNUAL =
|
6503
6763
|
T.let(
|
@@ -6561,8 +6821,12 @@ module Orb
|
|
6561
6821
|
)
|
6562
6822
|
.returns(T.attached_class)
|
6563
6823
|
end
|
6564
|
-
def self.new(
|
6565
|
-
|
6824
|
+
def self.new(
|
6825
|
+
# The duration of the billing period.
|
6826
|
+
duration:,
|
6827
|
+
# The unit of billing period duration.
|
6828
|
+
duration_unit:
|
6829
|
+
); end
|
6566
6830
|
sig do
|
6567
6831
|
override
|
6568
6832
|
.returns(
|
@@ -6582,14 +6846,7 @@ module Orb
|
|
6582
6846
|
T.type_alias do
|
6583
6847
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit)
|
6584
6848
|
end
|
6585
|
-
OrSymbol =
|
6586
|
-
T.type_alias do
|
6587
|
-
T.any(
|
6588
|
-
Symbol,
|
6589
|
-
String,
|
6590
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
6591
|
-
)
|
6592
|
-
end
|
6849
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
6593
6850
|
|
6594
6851
|
DAY =
|
6595
6852
|
T.let(
|
@@ -6636,8 +6893,12 @@ module Orb
|
|
6636
6893
|
)
|
6637
6894
|
.returns(T.attached_class)
|
6638
6895
|
end
|
6639
|
-
def self.new(
|
6640
|
-
|
6896
|
+
def self.new(
|
6897
|
+
# The duration of the billing period.
|
6898
|
+
duration:,
|
6899
|
+
# The unit of billing period duration.
|
6900
|
+
duration_unit:
|
6901
|
+
); end
|
6641
6902
|
sig do
|
6642
6903
|
override
|
6643
6904
|
.returns(
|
@@ -6657,14 +6918,7 @@ module Orb
|
|
6657
6918
|
T.type_alias do
|
6658
6919
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit)
|
6659
6920
|
end
|
6660
|
-
OrSymbol =
|
6661
|
-
T.type_alias do
|
6662
|
-
T.any(
|
6663
|
-
Symbol,
|
6664
|
-
String,
|
6665
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
6666
|
-
)
|
6667
|
-
end
|
6921
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
6668
6922
|
|
6669
6923
|
DAY =
|
6670
6924
|
T.let(
|
@@ -6826,19 +7080,40 @@ module Orb
|
|
6826
7080
|
.returns(T.attached_class)
|
6827
7081
|
end
|
6828
7082
|
def self.new(
|
7083
|
+
# The cadence to bill for this price on.
|
6829
7084
|
cadence:,
|
6830
7085
|
grouped_with_metered_minimum_config:,
|
7086
|
+
# The id of the item the price will be associated with.
|
6831
7087
|
item_id:,
|
7088
|
+
# The name of the price.
|
6832
7089
|
name:,
|
7090
|
+
# The id of the billable metric for the price. Only needed if the price is
|
7091
|
+
# usage-based.
|
6833
7092
|
billable_metric_id: nil,
|
7093
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
7094
|
+
# this is true, and in-arrears if this is false.
|
6834
7095
|
billed_in_advance: nil,
|
7096
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
7097
|
+
# months.
|
6835
7098
|
billing_cycle_configuration: nil,
|
7099
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
6836
7100
|
conversion_rate: nil,
|
7101
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
7102
|
+
# price is billed.
|
6837
7103
|
currency: nil,
|
7104
|
+
# An alias for the price.
|
6838
7105
|
external_price_id: nil,
|
7106
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
7107
|
+
# applied.
|
6839
7108
|
fixed_price_quantity: nil,
|
7109
|
+
# The property used to group this price on an invoice
|
6840
7110
|
invoice_grouping_key: nil,
|
7111
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7112
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
6841
7113
|
invoicing_cycle_configuration: nil,
|
7114
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
7115
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
7116
|
+
# by setting `metadata` to `null`.
|
6842
7117
|
metadata: nil,
|
6843
7118
|
model_type: :grouped_with_metered_minimum
|
6844
7119
|
); end
|
@@ -6876,14 +7151,7 @@ module Orb
|
|
6876
7151
|
|
6877
7152
|
TaggedSymbol =
|
6878
7153
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence) }
|
6879
|
-
OrSymbol =
|
6880
|
-
T.type_alias do
|
6881
|
-
T.any(
|
6882
|
-
Symbol,
|
6883
|
-
String,
|
6884
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol
|
6885
|
-
)
|
6886
|
-
end
|
7154
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
6887
7155
|
|
6888
7156
|
ANNUAL =
|
6889
7157
|
T.let(
|
@@ -6947,8 +7215,12 @@ module Orb
|
|
6947
7215
|
)
|
6948
7216
|
.returns(T.attached_class)
|
6949
7217
|
end
|
6950
|
-
def self.new(
|
6951
|
-
|
7218
|
+
def self.new(
|
7219
|
+
# The duration of the billing period.
|
7220
|
+
duration:,
|
7221
|
+
# The unit of billing period duration.
|
7222
|
+
duration_unit:
|
7223
|
+
); end
|
6952
7224
|
sig do
|
6953
7225
|
override
|
6954
7226
|
.returns(
|
@@ -6968,14 +7240,7 @@ module Orb
|
|
6968
7240
|
T.type_alias do
|
6969
7241
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit)
|
6970
7242
|
end
|
6971
|
-
OrSymbol =
|
6972
|
-
T.type_alias do
|
6973
|
-
T.any(
|
6974
|
-
Symbol,
|
6975
|
-
String,
|
6976
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
6977
|
-
)
|
6978
|
-
end
|
7243
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
6979
7244
|
|
6980
7245
|
DAY =
|
6981
7246
|
T.let(
|
@@ -7022,8 +7287,12 @@ module Orb
|
|
7022
7287
|
)
|
7023
7288
|
.returns(T.attached_class)
|
7024
7289
|
end
|
7025
|
-
def self.new(
|
7026
|
-
|
7290
|
+
def self.new(
|
7291
|
+
# The duration of the billing period.
|
7292
|
+
duration:,
|
7293
|
+
# The unit of billing period duration.
|
7294
|
+
duration_unit:
|
7295
|
+
); end
|
7027
7296
|
sig do
|
7028
7297
|
override
|
7029
7298
|
.returns(
|
@@ -7043,14 +7312,7 @@ module Orb
|
|
7043
7312
|
T.type_alias do
|
7044
7313
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit)
|
7045
7314
|
end
|
7046
|
-
OrSymbol =
|
7047
|
-
T.type_alias do
|
7048
|
-
T.any(
|
7049
|
-
Symbol,
|
7050
|
-
String,
|
7051
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
7052
|
-
)
|
7053
|
-
end
|
7315
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
7054
7316
|
|
7055
7317
|
DAY =
|
7056
7318
|
T.let(
|
@@ -7212,19 +7474,40 @@ module Orb
|
|
7212
7474
|
.returns(T.attached_class)
|
7213
7475
|
end
|
7214
7476
|
def self.new(
|
7477
|
+
# The cadence to bill for this price on.
|
7215
7478
|
cadence:,
|
7479
|
+
# The id of the item the price will be associated with.
|
7216
7480
|
item_id:,
|
7217
7481
|
matrix_with_display_name_config:,
|
7482
|
+
# The name of the price.
|
7218
7483
|
name:,
|
7484
|
+
# The id of the billable metric for the price. Only needed if the price is
|
7485
|
+
# usage-based.
|
7219
7486
|
billable_metric_id: nil,
|
7487
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
7488
|
+
# this is true, and in-arrears if this is false.
|
7220
7489
|
billed_in_advance: nil,
|
7490
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
7491
|
+
# months.
|
7221
7492
|
billing_cycle_configuration: nil,
|
7493
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
7222
7494
|
conversion_rate: nil,
|
7495
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
7496
|
+
# price is billed.
|
7223
7497
|
currency: nil,
|
7498
|
+
# An alias for the price.
|
7224
7499
|
external_price_id: nil,
|
7500
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
7501
|
+
# applied.
|
7225
7502
|
fixed_price_quantity: nil,
|
7503
|
+
# The property used to group this price on an invoice
|
7226
7504
|
invoice_grouping_key: nil,
|
7505
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7506
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7227
7507
|
invoicing_cycle_configuration: nil,
|
7508
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
7509
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
7510
|
+
# by setting `metadata` to `null`.
|
7228
7511
|
metadata: nil,
|
7229
7512
|
model_type: :matrix_with_display_name
|
7230
7513
|
); end
|
@@ -7262,14 +7545,7 @@ module Orb
|
|
7262
7545
|
|
7263
7546
|
TaggedSymbol =
|
7264
7547
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence) }
|
7265
|
-
OrSymbol =
|
7266
|
-
T.type_alias do
|
7267
|
-
T.any(
|
7268
|
-
Symbol,
|
7269
|
-
String,
|
7270
|
-
Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::Cadence::TaggedSymbol
|
7271
|
-
)
|
7272
|
-
end
|
7548
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
7273
7549
|
|
7274
7550
|
ANNUAL =
|
7275
7551
|
T.let(
|
@@ -7333,8 +7609,12 @@ module Orb
|
|
7333
7609
|
)
|
7334
7610
|
.returns(T.attached_class)
|
7335
7611
|
end
|
7336
|
-
def self.new(
|
7337
|
-
|
7612
|
+
def self.new(
|
7613
|
+
# The duration of the billing period.
|
7614
|
+
duration:,
|
7615
|
+
# The unit of billing period duration.
|
7616
|
+
duration_unit:
|
7617
|
+
); end
|
7338
7618
|
sig do
|
7339
7619
|
override
|
7340
7620
|
.returns(
|
@@ -7354,14 +7634,7 @@ module Orb
|
|
7354
7634
|
T.type_alias do
|
7355
7635
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit)
|
7356
7636
|
end
|
7357
|
-
OrSymbol =
|
7358
|
-
T.type_alias do
|
7359
|
-
T.any(
|
7360
|
-
Symbol,
|
7361
|
-
String,
|
7362
|
-
Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
7363
|
-
)
|
7364
|
-
end
|
7637
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
7365
7638
|
|
7366
7639
|
DAY =
|
7367
7640
|
T.let(
|
@@ -7408,8 +7681,12 @@ module Orb
|
|
7408
7681
|
)
|
7409
7682
|
.returns(T.attached_class)
|
7410
7683
|
end
|
7411
|
-
def self.new(
|
7412
|
-
|
7684
|
+
def self.new(
|
7685
|
+
# The duration of the billing period.
|
7686
|
+
duration:,
|
7687
|
+
# The unit of billing period duration.
|
7688
|
+
duration_unit:
|
7689
|
+
); end
|
7413
7690
|
sig do
|
7414
7691
|
override
|
7415
7692
|
.returns(
|
@@ -7429,14 +7706,7 @@ module Orb
|
|
7429
7706
|
T.type_alias do
|
7430
7707
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit)
|
7431
7708
|
end
|
7432
|
-
OrSymbol =
|
7433
|
-
T.type_alias do
|
7434
|
-
T.any(
|
7435
|
-
Symbol,
|
7436
|
-
String,
|
7437
|
-
Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
7438
|
-
)
|
7439
|
-
end
|
7709
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
7440
7710
|
|
7441
7711
|
DAY =
|
7442
7712
|
T.let(
|
@@ -7597,18 +7867,39 @@ module Orb
|
|
7597
7867
|
end
|
7598
7868
|
def self.new(
|
7599
7869
|
bulk_with_proration_config:,
|
7870
|
+
# The cadence to bill for this price on.
|
7600
7871
|
cadence:,
|
7872
|
+
# The id of the item the price will be associated with.
|
7601
7873
|
item_id:,
|
7874
|
+
# The name of the price.
|
7602
7875
|
name:,
|
7876
|
+
# The id of the billable metric for the price. Only needed if the price is
|
7877
|
+
# usage-based.
|
7603
7878
|
billable_metric_id: nil,
|
7879
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
7880
|
+
# this is true, and in-arrears if this is false.
|
7604
7881
|
billed_in_advance: nil,
|
7882
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
7883
|
+
# months.
|
7605
7884
|
billing_cycle_configuration: nil,
|
7885
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
7606
7886
|
conversion_rate: nil,
|
7887
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
7888
|
+
# price is billed.
|
7607
7889
|
currency: nil,
|
7890
|
+
# An alias for the price.
|
7608
7891
|
external_price_id: nil,
|
7892
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
7893
|
+
# applied.
|
7609
7894
|
fixed_price_quantity: nil,
|
7895
|
+
# The property used to group this price on an invoice
|
7610
7896
|
invoice_grouping_key: nil,
|
7897
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7898
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7611
7899
|
invoicing_cycle_configuration: nil,
|
7900
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
7901
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
7902
|
+
# by setting `metadata` to `null`.
|
7612
7903
|
metadata: nil,
|
7613
7904
|
model_type: :bulk_with_proration
|
7614
7905
|
); end
|
@@ -7644,14 +7935,7 @@ module Orb
|
|
7644
7935
|
|
7645
7936
|
TaggedSymbol =
|
7646
7937
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence) }
|
7647
|
-
OrSymbol =
|
7648
|
-
T.type_alias do
|
7649
|
-
T.any(
|
7650
|
-
Symbol,
|
7651
|
-
String,
|
7652
|
-
Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence::TaggedSymbol
|
7653
|
-
)
|
7654
|
-
end
|
7938
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
7655
7939
|
|
7656
7940
|
ANNUAL =
|
7657
7941
|
T.let(:annual, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::Cadence::TaggedSymbol)
|
@@ -7709,8 +7993,12 @@ module Orb
|
|
7709
7993
|
)
|
7710
7994
|
.returns(T.attached_class)
|
7711
7995
|
end
|
7712
|
-
def self.new(
|
7713
|
-
|
7996
|
+
def self.new(
|
7997
|
+
# The duration of the billing period.
|
7998
|
+
duration:,
|
7999
|
+
# The unit of billing period duration.
|
8000
|
+
duration_unit:
|
8001
|
+
); end
|
7714
8002
|
sig do
|
7715
8003
|
override
|
7716
8004
|
.returns(
|
@@ -7730,14 +8018,7 @@ module Orb
|
|
7730
8018
|
T.type_alias do
|
7731
8019
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit)
|
7732
8020
|
end
|
7733
|
-
OrSymbol =
|
7734
|
-
T.type_alias do
|
7735
|
-
T.any(
|
7736
|
-
Symbol,
|
7737
|
-
String,
|
7738
|
-
Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
7739
|
-
)
|
7740
|
-
end
|
8021
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
7741
8022
|
|
7742
8023
|
DAY =
|
7743
8024
|
T.let(
|
@@ -7784,8 +8065,12 @@ module Orb
|
|
7784
8065
|
)
|
7785
8066
|
.returns(T.attached_class)
|
7786
8067
|
end
|
7787
|
-
def self.new(
|
7788
|
-
|
8068
|
+
def self.new(
|
8069
|
+
# The duration of the billing period.
|
8070
|
+
duration:,
|
8071
|
+
# The unit of billing period duration.
|
8072
|
+
duration_unit:
|
8073
|
+
); end
|
7789
8074
|
sig do
|
7790
8075
|
override
|
7791
8076
|
.returns(
|
@@ -7805,14 +8090,7 @@ module Orb
|
|
7805
8090
|
T.type_alias do
|
7806
8091
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit)
|
7807
8092
|
end
|
7808
|
-
OrSymbol =
|
7809
|
-
T.type_alias do
|
7810
|
-
T.any(
|
7811
|
-
Symbol,
|
7812
|
-
String,
|
7813
|
-
Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
7814
|
-
)
|
7815
|
-
end
|
8093
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
7816
8094
|
|
7817
8095
|
DAY =
|
7818
8096
|
T.let(
|
@@ -7974,19 +8252,40 @@ module Orb
|
|
7974
8252
|
.returns(T.attached_class)
|
7975
8253
|
end
|
7976
8254
|
def self.new(
|
8255
|
+
# The cadence to bill for this price on.
|
7977
8256
|
cadence:,
|
7978
8257
|
grouped_tiered_package_config:,
|
8258
|
+
# The id of the item the price will be associated with.
|
7979
8259
|
item_id:,
|
8260
|
+
# The name of the price.
|
7980
8261
|
name:,
|
8262
|
+
# The id of the billable metric for the price. Only needed if the price is
|
8263
|
+
# usage-based.
|
7981
8264
|
billable_metric_id: nil,
|
8265
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
8266
|
+
# this is true, and in-arrears if this is false.
|
7982
8267
|
billed_in_advance: nil,
|
8268
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
8269
|
+
# months.
|
7983
8270
|
billing_cycle_configuration: nil,
|
8271
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
7984
8272
|
conversion_rate: nil,
|
8273
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
8274
|
+
# price is billed.
|
7985
8275
|
currency: nil,
|
8276
|
+
# An alias for the price.
|
7986
8277
|
external_price_id: nil,
|
8278
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
8279
|
+
# applied.
|
7987
8280
|
fixed_price_quantity: nil,
|
8281
|
+
# The property used to group this price on an invoice
|
7988
8282
|
invoice_grouping_key: nil,
|
8283
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
8284
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7989
8285
|
invoicing_cycle_configuration: nil,
|
8286
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
8287
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
8288
|
+
# by setting `metadata` to `null`.
|
7990
8289
|
metadata: nil,
|
7991
8290
|
model_type: :grouped_tiered_package
|
7992
8291
|
); end
|
@@ -8024,14 +8323,7 @@ module Orb
|
|
8024
8323
|
|
8025
8324
|
TaggedSymbol =
|
8026
8325
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence) }
|
8027
|
-
OrSymbol =
|
8028
|
-
T.type_alias do
|
8029
|
-
T.any(
|
8030
|
-
Symbol,
|
8031
|
-
String,
|
8032
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::Cadence::TaggedSymbol
|
8033
|
-
)
|
8034
|
-
end
|
8326
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
8035
8327
|
|
8036
8328
|
ANNUAL =
|
8037
8329
|
T.let(
|
@@ -8095,8 +8387,12 @@ module Orb
|
|
8095
8387
|
)
|
8096
8388
|
.returns(T.attached_class)
|
8097
8389
|
end
|
8098
|
-
def self.new(
|
8099
|
-
|
8390
|
+
def self.new(
|
8391
|
+
# The duration of the billing period.
|
8392
|
+
duration:,
|
8393
|
+
# The unit of billing period duration.
|
8394
|
+
duration_unit:
|
8395
|
+
); end
|
8100
8396
|
sig do
|
8101
8397
|
override
|
8102
8398
|
.returns(
|
@@ -8116,14 +8412,7 @@ module Orb
|
|
8116
8412
|
T.type_alias do
|
8117
8413
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit)
|
8118
8414
|
end
|
8119
|
-
OrSymbol =
|
8120
|
-
T.type_alias do
|
8121
|
-
T.any(
|
8122
|
-
Symbol,
|
8123
|
-
String,
|
8124
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
8125
|
-
)
|
8126
|
-
end
|
8415
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
8127
8416
|
|
8128
8417
|
DAY =
|
8129
8418
|
T.let(
|
@@ -8170,8 +8459,12 @@ module Orb
|
|
8170
8459
|
)
|
8171
8460
|
.returns(T.attached_class)
|
8172
8461
|
end
|
8173
|
-
def self.new(
|
8174
|
-
|
8462
|
+
def self.new(
|
8463
|
+
# The duration of the billing period.
|
8464
|
+
duration:,
|
8465
|
+
# The unit of billing period duration.
|
8466
|
+
duration_unit:
|
8467
|
+
); end
|
8175
8468
|
sig do
|
8176
8469
|
override
|
8177
8470
|
.returns(
|
@@ -8191,14 +8484,7 @@ module Orb
|
|
8191
8484
|
T.type_alias do
|
8192
8485
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit)
|
8193
8486
|
end
|
8194
|
-
OrSymbol =
|
8195
|
-
T.type_alias do
|
8196
|
-
T.any(
|
8197
|
-
Symbol,
|
8198
|
-
String,
|
8199
|
-
Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
8200
|
-
)
|
8201
|
-
end
|
8487
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
8202
8488
|
|
8203
8489
|
DAY =
|
8204
8490
|
T.let(
|
@@ -8360,19 +8646,40 @@ module Orb
|
|
8360
8646
|
.returns(T.attached_class)
|
8361
8647
|
end
|
8362
8648
|
def self.new(
|
8649
|
+
# The cadence to bill for this price on.
|
8363
8650
|
cadence:,
|
8651
|
+
# The id of the item the price will be associated with.
|
8364
8652
|
item_id:,
|
8365
8653
|
max_group_tiered_package_config:,
|
8654
|
+
# The name of the price.
|
8366
8655
|
name:,
|
8656
|
+
# The id of the billable metric for the price. Only needed if the price is
|
8657
|
+
# usage-based.
|
8367
8658
|
billable_metric_id: nil,
|
8659
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
8660
|
+
# this is true, and in-arrears if this is false.
|
8368
8661
|
billed_in_advance: nil,
|
8662
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
8663
|
+
# months.
|
8369
8664
|
billing_cycle_configuration: nil,
|
8665
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
8370
8666
|
conversion_rate: nil,
|
8667
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
8668
|
+
# price is billed.
|
8371
8669
|
currency: nil,
|
8670
|
+
# An alias for the price.
|
8372
8671
|
external_price_id: nil,
|
8672
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
8673
|
+
# applied.
|
8373
8674
|
fixed_price_quantity: nil,
|
8675
|
+
# The property used to group this price on an invoice
|
8374
8676
|
invoice_grouping_key: nil,
|
8677
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
8678
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
8375
8679
|
invoicing_cycle_configuration: nil,
|
8680
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
8681
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
8682
|
+
# by setting `metadata` to `null`.
|
8376
8683
|
metadata: nil,
|
8377
8684
|
model_type: :max_group_tiered_package
|
8378
8685
|
); end
|
@@ -8410,14 +8717,7 @@ module Orb
|
|
8410
8717
|
|
8411
8718
|
TaggedSymbol =
|
8412
8719
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence) }
|
8413
|
-
OrSymbol =
|
8414
|
-
T.type_alias do
|
8415
|
-
T.any(
|
8416
|
-
Symbol,
|
8417
|
-
String,
|
8418
|
-
Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::Cadence::TaggedSymbol
|
8419
|
-
)
|
8420
|
-
end
|
8720
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
8421
8721
|
|
8422
8722
|
ANNUAL =
|
8423
8723
|
T.let(
|
@@ -8481,8 +8781,12 @@ module Orb
|
|
8481
8781
|
)
|
8482
8782
|
.returns(T.attached_class)
|
8483
8783
|
end
|
8484
|
-
def self.new(
|
8485
|
-
|
8784
|
+
def self.new(
|
8785
|
+
# The duration of the billing period.
|
8786
|
+
duration:,
|
8787
|
+
# The unit of billing period duration.
|
8788
|
+
duration_unit:
|
8789
|
+
); end
|
8486
8790
|
sig do
|
8487
8791
|
override
|
8488
8792
|
.returns(
|
@@ -8502,14 +8806,7 @@ module Orb
|
|
8502
8806
|
T.type_alias do
|
8503
8807
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit)
|
8504
8808
|
end
|
8505
|
-
OrSymbol =
|
8506
|
-
T.type_alias do
|
8507
|
-
T.any(
|
8508
|
-
Symbol,
|
8509
|
-
String,
|
8510
|
-
Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
8511
|
-
)
|
8512
|
-
end
|
8809
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
8513
8810
|
|
8514
8811
|
DAY =
|
8515
8812
|
T.let(
|
@@ -8556,8 +8853,12 @@ module Orb
|
|
8556
8853
|
)
|
8557
8854
|
.returns(T.attached_class)
|
8558
8855
|
end
|
8559
|
-
def self.new(
|
8560
|
-
|
8856
|
+
def self.new(
|
8857
|
+
# The duration of the billing period.
|
8858
|
+
duration:,
|
8859
|
+
# The unit of billing period duration.
|
8860
|
+
duration_unit:
|
8861
|
+
); end
|
8561
8862
|
sig do
|
8562
8863
|
override
|
8563
8864
|
.returns(
|
@@ -8577,14 +8878,7 @@ module Orb
|
|
8577
8878
|
T.type_alias do
|
8578
8879
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit)
|
8579
8880
|
end
|
8580
|
-
OrSymbol =
|
8581
|
-
T.type_alias do
|
8582
|
-
T.any(
|
8583
|
-
Symbol,
|
8584
|
-
String,
|
8585
|
-
Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
8586
|
-
)
|
8587
|
-
end
|
8881
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
8588
8882
|
|
8589
8883
|
DAY =
|
8590
8884
|
T.let(
|
@@ -8750,19 +9044,40 @@ module Orb
|
|
8750
9044
|
.returns(T.attached_class)
|
8751
9045
|
end
|
8752
9046
|
def self.new(
|
9047
|
+
# The cadence to bill for this price on.
|
8753
9048
|
cadence:,
|
9049
|
+
# The id of the item the price will be associated with.
|
8754
9050
|
item_id:,
|
9051
|
+
# The name of the price.
|
8755
9052
|
name:,
|
8756
9053
|
scalable_matrix_with_unit_pricing_config:,
|
9054
|
+
# The id of the billable metric for the price. Only needed if the price is
|
9055
|
+
# usage-based.
|
8757
9056
|
billable_metric_id: nil,
|
9057
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
9058
|
+
# this is true, and in-arrears if this is false.
|
8758
9059
|
billed_in_advance: nil,
|
9060
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
9061
|
+
# months.
|
8759
9062
|
billing_cycle_configuration: nil,
|
9063
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
8760
9064
|
conversion_rate: nil,
|
9065
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
9066
|
+
# price is billed.
|
8761
9067
|
currency: nil,
|
9068
|
+
# An alias for the price.
|
8762
9069
|
external_price_id: nil,
|
9070
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
9071
|
+
# applied.
|
8763
9072
|
fixed_price_quantity: nil,
|
9073
|
+
# The property used to group this price on an invoice
|
8764
9074
|
invoice_grouping_key: nil,
|
9075
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
9076
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
8765
9077
|
invoicing_cycle_configuration: nil,
|
9078
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
9079
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
9080
|
+
# by setting `metadata` to `null`.
|
8766
9081
|
metadata: nil,
|
8767
9082
|
model_type: :scalable_matrix_with_unit_pricing
|
8768
9083
|
); end
|
@@ -8800,14 +9115,7 @@ module Orb
|
|
8800
9115
|
|
8801
9116
|
TaggedSymbol =
|
8802
9117
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence) }
|
8803
|
-
OrSymbol =
|
8804
|
-
T.type_alias do
|
8805
|
-
T.any(
|
8806
|
-
Symbol,
|
8807
|
-
String,
|
8808
|
-
Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol
|
8809
|
-
)
|
8810
|
-
end
|
9118
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
8811
9119
|
|
8812
9120
|
ANNUAL =
|
8813
9121
|
T.let(
|
@@ -8871,8 +9179,12 @@ module Orb
|
|
8871
9179
|
)
|
8872
9180
|
.returns(T.attached_class)
|
8873
9181
|
end
|
8874
|
-
def self.new(
|
8875
|
-
|
9182
|
+
def self.new(
|
9183
|
+
# The duration of the billing period.
|
9184
|
+
duration:,
|
9185
|
+
# The unit of billing period duration.
|
9186
|
+
duration_unit:
|
9187
|
+
); end
|
8876
9188
|
sig do
|
8877
9189
|
override
|
8878
9190
|
.returns(
|
@@ -8892,14 +9204,7 @@ module Orb
|
|
8892
9204
|
T.type_alias do
|
8893
9205
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit)
|
8894
9206
|
end
|
8895
|
-
OrSymbol =
|
8896
|
-
T.type_alias do
|
8897
|
-
T.any(
|
8898
|
-
Symbol,
|
8899
|
-
String,
|
8900
|
-
Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
8901
|
-
)
|
8902
|
-
end
|
9207
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
8903
9208
|
|
8904
9209
|
DAY =
|
8905
9210
|
T.let(
|
@@ -8946,8 +9251,12 @@ module Orb
|
|
8946
9251
|
)
|
8947
9252
|
.returns(T.attached_class)
|
8948
9253
|
end
|
8949
|
-
def self.new(
|
8950
|
-
|
9254
|
+
def self.new(
|
9255
|
+
# The duration of the billing period.
|
9256
|
+
duration:,
|
9257
|
+
# The unit of billing period duration.
|
9258
|
+
duration_unit:
|
9259
|
+
); end
|
8951
9260
|
sig do
|
8952
9261
|
override
|
8953
9262
|
.returns(
|
@@ -8967,14 +9276,7 @@ module Orb
|
|
8967
9276
|
T.type_alias do
|
8968
9277
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit)
|
8969
9278
|
end
|
8970
|
-
OrSymbol =
|
8971
|
-
T.type_alias do
|
8972
|
-
T.any(
|
8973
|
-
Symbol,
|
8974
|
-
String,
|
8975
|
-
Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
8976
|
-
)
|
8977
|
-
end
|
9279
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
8978
9280
|
|
8979
9281
|
DAY =
|
8980
9282
|
T.let(
|
@@ -9140,19 +9442,40 @@ module Orb
|
|
9140
9442
|
.returns(T.attached_class)
|
9141
9443
|
end
|
9142
9444
|
def self.new(
|
9445
|
+
# The cadence to bill for this price on.
|
9143
9446
|
cadence:,
|
9447
|
+
# The id of the item the price will be associated with.
|
9144
9448
|
item_id:,
|
9449
|
+
# The name of the price.
|
9145
9450
|
name:,
|
9146
9451
|
scalable_matrix_with_tiered_pricing_config:,
|
9452
|
+
# The id of the billable metric for the price. Only needed if the price is
|
9453
|
+
# usage-based.
|
9147
9454
|
billable_metric_id: nil,
|
9455
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
9456
|
+
# this is true, and in-arrears if this is false.
|
9148
9457
|
billed_in_advance: nil,
|
9458
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
9459
|
+
# months.
|
9149
9460
|
billing_cycle_configuration: nil,
|
9461
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
9150
9462
|
conversion_rate: nil,
|
9463
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
9464
|
+
# price is billed.
|
9151
9465
|
currency: nil,
|
9466
|
+
# An alias for the price.
|
9152
9467
|
external_price_id: nil,
|
9468
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
9469
|
+
# applied.
|
9153
9470
|
fixed_price_quantity: nil,
|
9471
|
+
# The property used to group this price on an invoice
|
9154
9472
|
invoice_grouping_key: nil,
|
9473
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
9474
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
9155
9475
|
invoicing_cycle_configuration: nil,
|
9476
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
9477
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
9478
|
+
# by setting `metadata` to `null`.
|
9156
9479
|
metadata: nil,
|
9157
9480
|
model_type: :scalable_matrix_with_tiered_pricing
|
9158
9481
|
); end
|
@@ -9190,14 +9513,7 @@ module Orb
|
|
9190
9513
|
|
9191
9514
|
TaggedSymbol =
|
9192
9515
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence) }
|
9193
|
-
OrSymbol =
|
9194
|
-
T.type_alias do
|
9195
|
-
T.any(
|
9196
|
-
Symbol,
|
9197
|
-
String,
|
9198
|
-
Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol
|
9199
|
-
)
|
9200
|
-
end
|
9516
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
9201
9517
|
|
9202
9518
|
ANNUAL =
|
9203
9519
|
T.let(
|
@@ -9261,8 +9577,12 @@ module Orb
|
|
9261
9577
|
)
|
9262
9578
|
.returns(T.attached_class)
|
9263
9579
|
end
|
9264
|
-
def self.new(
|
9265
|
-
|
9580
|
+
def self.new(
|
9581
|
+
# The duration of the billing period.
|
9582
|
+
duration:,
|
9583
|
+
# The unit of billing period duration.
|
9584
|
+
duration_unit:
|
9585
|
+
); end
|
9266
9586
|
sig do
|
9267
9587
|
override
|
9268
9588
|
.returns(
|
@@ -9282,14 +9602,7 @@ module Orb
|
|
9282
9602
|
T.type_alias do
|
9283
9603
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit)
|
9284
9604
|
end
|
9285
|
-
OrSymbol =
|
9286
|
-
T.type_alias do
|
9287
|
-
T.any(
|
9288
|
-
Symbol,
|
9289
|
-
String,
|
9290
|
-
Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
9291
|
-
)
|
9292
|
-
end
|
9605
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
9293
9606
|
|
9294
9607
|
DAY =
|
9295
9608
|
T.let(
|
@@ -9336,8 +9649,12 @@ module Orb
|
|
9336
9649
|
)
|
9337
9650
|
.returns(T.attached_class)
|
9338
9651
|
end
|
9339
|
-
def self.new(
|
9340
|
-
|
9652
|
+
def self.new(
|
9653
|
+
# The duration of the billing period.
|
9654
|
+
duration:,
|
9655
|
+
# The unit of billing period duration.
|
9656
|
+
duration_unit:
|
9657
|
+
); end
|
9341
9658
|
sig do
|
9342
9659
|
override
|
9343
9660
|
.returns(
|
@@ -9357,14 +9674,7 @@ module Orb
|
|
9357
9674
|
T.type_alias do
|
9358
9675
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit)
|
9359
9676
|
end
|
9360
|
-
OrSymbol =
|
9361
|
-
T.type_alias do
|
9362
|
-
T.any(
|
9363
|
-
Symbol,
|
9364
|
-
String,
|
9365
|
-
Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
9366
|
-
)
|
9367
|
-
end
|
9677
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
9368
9678
|
|
9369
9679
|
DAY =
|
9370
9680
|
T.let(
|
@@ -9526,19 +9836,40 @@ module Orb
|
|
9526
9836
|
.returns(T.attached_class)
|
9527
9837
|
end
|
9528
9838
|
def self.new(
|
9839
|
+
# The cadence to bill for this price on.
|
9529
9840
|
cadence:,
|
9530
9841
|
cumulative_grouped_bulk_config:,
|
9842
|
+
# The id of the item the price will be associated with.
|
9531
9843
|
item_id:,
|
9844
|
+
# The name of the price.
|
9532
9845
|
name:,
|
9846
|
+
# The id of the billable metric for the price. Only needed if the price is
|
9847
|
+
# usage-based.
|
9533
9848
|
billable_metric_id: nil,
|
9849
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
9850
|
+
# this is true, and in-arrears if this is false.
|
9534
9851
|
billed_in_advance: nil,
|
9852
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
9853
|
+
# months.
|
9535
9854
|
billing_cycle_configuration: nil,
|
9855
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
9536
9856
|
conversion_rate: nil,
|
9857
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
9858
|
+
# price is billed.
|
9537
9859
|
currency: nil,
|
9860
|
+
# An alias for the price.
|
9538
9861
|
external_price_id: nil,
|
9862
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
9863
|
+
# applied.
|
9539
9864
|
fixed_price_quantity: nil,
|
9865
|
+
# The property used to group this price on an invoice
|
9540
9866
|
invoice_grouping_key: nil,
|
9867
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
9868
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
9541
9869
|
invoicing_cycle_configuration: nil,
|
9870
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
9871
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
9872
|
+
# by setting `metadata` to `null`.
|
9542
9873
|
metadata: nil,
|
9543
9874
|
model_type: :cumulative_grouped_bulk
|
9544
9875
|
); end
|
@@ -9576,14 +9907,7 @@ module Orb
|
|
9576
9907
|
|
9577
9908
|
TaggedSymbol =
|
9578
9909
|
T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence) }
|
9579
|
-
OrSymbol =
|
9580
|
-
T.type_alias do
|
9581
|
-
T.any(
|
9582
|
-
Symbol,
|
9583
|
-
String,
|
9584
|
-
Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::Cadence::TaggedSymbol
|
9585
|
-
)
|
9586
|
-
end
|
9910
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
9587
9911
|
|
9588
9912
|
ANNUAL =
|
9589
9913
|
T.let(
|
@@ -9647,8 +9971,12 @@ module Orb
|
|
9647
9971
|
)
|
9648
9972
|
.returns(T.attached_class)
|
9649
9973
|
end
|
9650
|
-
def self.new(
|
9651
|
-
|
9974
|
+
def self.new(
|
9975
|
+
# The duration of the billing period.
|
9976
|
+
duration:,
|
9977
|
+
# The unit of billing period duration.
|
9978
|
+
duration_unit:
|
9979
|
+
); end
|
9652
9980
|
sig do
|
9653
9981
|
override
|
9654
9982
|
.returns(
|
@@ -9668,14 +9996,7 @@ module Orb
|
|
9668
9996
|
T.type_alias do
|
9669
9997
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit)
|
9670
9998
|
end
|
9671
|
-
OrSymbol =
|
9672
|
-
T.type_alias do
|
9673
|
-
T.any(
|
9674
|
-
Symbol,
|
9675
|
-
String,
|
9676
|
-
Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
9677
|
-
)
|
9678
|
-
end
|
9999
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
9679
10000
|
|
9680
10001
|
DAY =
|
9681
10002
|
T.let(
|
@@ -9722,8 +10043,12 @@ module Orb
|
|
9722
10043
|
)
|
9723
10044
|
.returns(T.attached_class)
|
9724
10045
|
end
|
9725
|
-
def self.new(
|
9726
|
-
|
10046
|
+
def self.new(
|
10047
|
+
# The duration of the billing period.
|
10048
|
+
duration:,
|
10049
|
+
# The unit of billing period duration.
|
10050
|
+
duration_unit:
|
10051
|
+
); end
|
9727
10052
|
sig do
|
9728
10053
|
override
|
9729
10054
|
.returns(
|
@@ -9743,14 +10068,7 @@ module Orb
|
|
9743
10068
|
T.type_alias do
|
9744
10069
|
T.all(Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit)
|
9745
10070
|
end
|
9746
|
-
OrSymbol =
|
9747
|
-
T.type_alias do
|
9748
|
-
T.any(
|
9749
|
-
Symbol,
|
9750
|
-
String,
|
9751
|
-
Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
9752
|
-
)
|
9753
|
-
end
|
10071
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
9754
10072
|
|
9755
10073
|
DAY =
|
9756
10074
|
T.let(
|
@@ -9791,7 +10109,7 @@ module Orb
|
|
9791
10109
|
extend Orb::Internal::Type::Enum
|
9792
10110
|
|
9793
10111
|
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PlanCreateParams::Status) }
|
9794
|
-
OrSymbol = T.type_alias { T.any(Symbol, String
|
10112
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
9795
10113
|
|
9796
10114
|
ACTIVE = T.let(:active, Orb::Models::PlanCreateParams::Status::TaggedSymbol)
|
9797
10115
|
DRAFT = T.let(:draft, Orb::Models::PlanCreateParams::Status::TaggedSymbol)
|