orb-billing 0.1.0.pre.alpha.33
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 +7 -0
- data/README.md +169 -0
- data/lib/orb/client.rb +129 -0
- data/lib/orb/errors.rb +317 -0
- data/lib/orb/models/alert.rb +225 -0
- data/lib/orb/models/alert_create_for_customer_params.rb +77 -0
- data/lib/orb/models/alert_create_for_external_customer_params.rb +77 -0
- data/lib/orb/models/alert_create_for_subscription_params.rb +74 -0
- data/lib/orb/models/alert_disable_params.rb +26 -0
- data/lib/orb/models/alert_enable_params.rb +26 -0
- data/lib/orb/models/alert_list_params.rb +97 -0
- data/lib/orb/models/alert_retrieve_params.rb +19 -0
- data/lib/orb/models/alert_update_params.rb +46 -0
- data/lib/orb/models/amount_discount.rb +53 -0
- data/lib/orb/models/billable_metric.rb +76 -0
- data/lib/orb/models/billing_cycle_relative_date.rb +18 -0
- data/lib/orb/models/coupon.rb +86 -0
- data/lib/orb/models/coupon_archive_params.rb +19 -0
- data/lib/orb/models/coupon_create_params.rb +102 -0
- data/lib/orb/models/coupon_fetch_params.rb +19 -0
- data/lib/orb/models/coupon_list_params.rb +53 -0
- data/lib/orb/models/coupons/subscription_list_params.rb +40 -0
- data/lib/orb/models/credit_note.rb +522 -0
- data/lib/orb/models/credit_note_create_params.rb +77 -0
- data/lib/orb/models/credit_note_fetch_params.rb +19 -0
- data/lib/orb/models/credit_note_list_params.rb +73 -0
- data/lib/orb/models/customer.rb +872 -0
- data/lib/orb/models/customer_create_params.rb +843 -0
- data/lib/orb/models/customer_delete_params.rb +19 -0
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +19 -0
- data/lib/orb/models/customer_fetch_params.rb +19 -0
- data/lib/orb/models/customer_list_params.rb +73 -0
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +19 -0
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +19 -0
- data/lib/orb/models/customer_update_by_external_id_params.rb +848 -0
- data/lib/orb/models/customer_update_params.rb +838 -0
- data/lib/orb/models/customers/balance_transaction_create_params.rb +53 -0
- data/lib/orb/models/customers/balance_transaction_create_response.rb +167 -0
- data/lib/orb/models/customers/balance_transaction_list_params.rb +75 -0
- data/lib/orb/models/customers/balance_transaction_list_response.rb +167 -0
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +69 -0
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +106 -0
- data/lib/orb/models/customers/cost_list_params.rb +69 -0
- data/lib/orb/models/customers/cost_list_response.rb +106 -0
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +59 -0
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +72 -0
- data/lib/orb/models/customers/credit_list_params.rb +59 -0
- data/lib/orb/models/customers/credit_list_response.rb +72 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +215 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +1311 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +214 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +1310 -0
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +141 -0
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +1310 -0
- data/lib/orb/models/customers/credits/ledger_list_params.rb +141 -0
- data/lib/orb/models/customers/credits/ledger_list_response.rb +1306 -0
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +159 -0
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +154 -0
- data/lib/orb/models/customers/credits/top_up_create_params.rb +158 -0
- data/lib/orb/models/customers/credits/top_up_create_response.rb +153 -0
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +29 -0
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +29 -0
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +42 -0
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +154 -0
- data/lib/orb/models/customers/credits/top_up_list_params.rb +42 -0
- data/lib/orb/models/customers/credits/top_up_list_response.rb +153 -0
- data/lib/orb/models/dimensional_price_group.rb +64 -0
- data/lib/orb/models/dimensional_price_group_create_params.rb +63 -0
- data/lib/orb/models/dimensional_price_group_list_params.rb +38 -0
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +19 -0
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +21 -0
- data/lib/orb/models/dimensional_price_groups.rb +25 -0
- data/lib/orb/models/discount.rb +23 -0
- data/lib/orb/models/evaluate_price_group.rb +48 -0
- data/lib/orb/models/event_deprecate_params.rb +19 -0
- data/lib/orb/models/event_deprecate_response.rb +21 -0
- data/lib/orb/models/event_ingest_params.rb +100 -0
- data/lib/orb/models/event_ingest_response.rb +77 -0
- data/lib/orb/models/event_search_params.rb +45 -0
- data/lib/orb/models/event_search_response.rb +87 -0
- data/lib/orb/models/event_update_params.rb +58 -0
- data/lib/orb/models/event_update_response.rb +21 -0
- data/lib/orb/models/events/backfill_close_params.rb +21 -0
- data/lib/orb/models/events/backfill_close_response.rb +131 -0
- data/lib/orb/models/events/backfill_create_params.rb +97 -0
- data/lib/orb/models/events/backfill_create_response.rb +131 -0
- data/lib/orb/models/events/backfill_fetch_params.rb +21 -0
- data/lib/orb/models/events/backfill_fetch_response.rb +131 -0
- data/lib/orb/models/events/backfill_list_params.rb +40 -0
- data/lib/orb/models/events/backfill_list_response.rb +131 -0
- data/lib/orb/models/events/backfill_revert_params.rb +21 -0
- data/lib/orb/models/events/backfill_revert_response.rb +131 -0
- data/lib/orb/models/events/event_volumes.rb +54 -0
- data/lib/orb/models/events/volume_list_params.rb +64 -0
- data/lib/orb/models/invoice.rb +2218 -0
- data/lib/orb/models/invoice_create_params.rb +200 -0
- data/lib/orb/models/invoice_fetch_params.rb +19 -0
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +25 -0
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +2226 -0
- data/lib/orb/models/invoice_issue_params.rb +34 -0
- data/lib/orb/models/invoice_level_discount.rb +21 -0
- data/lib/orb/models/invoice_line_item_create_params.rb +62 -0
- data/lib/orb/models/invoice_line_item_create_response.rb +929 -0
- data/lib/orb/models/invoice_list_params.rb +197 -0
- data/lib/orb/models/invoice_mark_paid_params.rb +40 -0
- data/lib/orb/models/invoice_pay_params.rb +19 -0
- data/lib/orb/models/invoice_update_params.rb +28 -0
- data/lib/orb/models/invoice_void_params.rb +19 -0
- data/lib/orb/models/item.rb +82 -0
- data/lib/orb/models/item_create_params.rb +26 -0
- data/lib/orb/models/item_fetch_params.rb +19 -0
- data/lib/orb/models/item_list_params.rb +38 -0
- data/lib/orb/models/item_update_params.rb +73 -0
- data/lib/orb/models/metric_create_params.rb +56 -0
- data/lib/orb/models/metric_fetch_params.rb +19 -0
- data/lib/orb/models/metric_list_params.rb +73 -0
- data/lib/orb/models/metric_update_params.rb +28 -0
- data/lib/orb/models/pagination_metadata.rb +25 -0
- data/lib/orb/models/percentage_discount.rb +54 -0
- data/lib/orb/models/plan.rb +894 -0
- data/lib/orb/models/plan_create_params.rb +6702 -0
- data/lib/orb/models/plan_fetch_params.rb +19 -0
- data/lib/orb/models/plan_list_params.rb +100 -0
- data/lib/orb/models/plan_update_params.rb +37 -0
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +21 -0
- data/lib/orb/models/plans/external_plan_id_update_params.rb +39 -0
- data/lib/orb/models/price.rb +12229 -0
- data/lib/orb/models/price_create_params.rb +808 -0
- data/lib/orb/models/price_evaluate_params.rb +80 -0
- data/lib/orb/models/price_evaluate_response.rb +20 -0
- data/lib/orb/models/price_fetch_params.rb +19 -0
- data/lib/orb/models/price_list_params.rb +38 -0
- data/lib/orb/models/price_update_params.rb +28 -0
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +21 -0
- data/lib/orb/models/prices/external_price_id_update_params.rb +30 -0
- data/lib/orb/models/subscription.rb +1233 -0
- data/lib/orb/models/subscription_cancel_params.rb +58 -0
- data/lib/orb/models/subscription_cancel_response.rb +1217 -0
- data/lib/orb/models/subscription_create_params.rb +15065 -0
- data/lib/orb/models/subscription_create_response.rb +1217 -0
- data/lib/orb/models/subscription_fetch_costs_params.rb +67 -0
- data/lib/orb/models/subscription_fetch_costs_response.rb +104 -0
- data/lib/orb/models/subscription_fetch_params.rb +19 -0
- data/lib/orb/models/subscription_fetch_schedule_params.rb +73 -0
- data/lib/orb/models/subscription_fetch_schedule_response.rb +68 -0
- data/lib/orb/models/subscription_fetch_usage_params.rb +135 -0
- data/lib/orb/models/subscription_list_params.rb +108 -0
- data/lib/orb/models/subscription_price_intervals_params.rb +8358 -0
- data/lib/orb/models/subscription_price_intervals_response.rb +1224 -0
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +15088 -0
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +1224 -0
- data/lib/orb/models/subscription_trigger_phase_params.rb +36 -0
- data/lib/orb/models/subscription_trigger_phase_response.rb +1224 -0
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +19 -0
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +1224 -0
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +26 -0
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +1228 -0
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +19 -0
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +1224 -0
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +90 -0
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +1224 -0
- data/lib/orb/models/subscription_update_params.rb +74 -0
- data/lib/orb/models/subscription_update_trial_params.rb +59 -0
- data/lib/orb/models/subscription_update_trial_response.rb +1222 -0
- data/lib/orb/models/subscription_usage.rb +258 -0
- data/lib/orb/models/subscriptions.rb +25 -0
- data/lib/orb/models/top_level_ping_params.rb +19 -0
- data/lib/orb/models/top_level_ping_response.rb +20 -0
- data/lib/orb/models/trial_discount.rb +69 -0
- data/lib/orb/models/usage_discount.rb +54 -0
- data/lib/orb/page.rb +114 -0
- data/lib/orb/request_options.rb +75 -0
- data/lib/orb/resources/alerts.rb +239 -0
- data/lib/orb/resources/coupons/subscriptions.rb +43 -0
- data/lib/orb/resources/coupons.rb +115 -0
- data/lib/orb/resources/credit_notes.rb +87 -0
- data/lib/orb/resources/customers/balance_transactions.rb +96 -0
- data/lib/orb/resources/customers/costs.rb +298 -0
- data/lib/orb/resources/customers/credits/ledger.rb +527 -0
- data/lib/orb/resources/customers/credits/top_ups.rb +192 -0
- data/lib/orb/resources/customers/credits.rb +88 -0
- data/lib/orb/resources/customers.rb +321 -0
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +38 -0
- data/lib/orb/resources/dimensional_price_groups.rb +93 -0
- data/lib/orb/resources/events/backfills.rb +174 -0
- data/lib/orb/resources/events/volume.rb +52 -0
- data/lib/orb/resources/events.rb +415 -0
- data/lib/orb/resources/invoice_line_items.rb +41 -0
- data/lib/orb/resources/invoices.rb +266 -0
- data/lib/orb/resources/items.rb +95 -0
- data/lib/orb/resources/metrics.rb +114 -0
- data/lib/orb/resources/plans/external_plan_id.rb +76 -0
- data/lib/orb/resources/plans.rb +133 -0
- data/lib/orb/resources/prices/external_price_id.rb +61 -0
- data/lib/orb/resources/prices.rb +197 -0
- data/lib/orb/resources/subscriptions.rb +1278 -0
- data/lib/orb/resources/top_level.rb +37 -0
- data/lib/orb/transport/base_client.rb +459 -0
- data/lib/orb/transport/pooled_net_requester.rb +182 -0
- data/lib/orb/type/array_of.rb +112 -0
- data/lib/orb/type/base_model.rb +367 -0
- data/lib/orb/type/base_page.rb +61 -0
- data/lib/orb/type/boolean_model.rb +52 -0
- data/lib/orb/type/converter.rb +217 -0
- data/lib/orb/type/enum.rb +101 -0
- data/lib/orb/type/hash_of.rb +132 -0
- data/lib/orb/type/request_parameters.rb +38 -0
- data/lib/orb/type/union.rb +225 -0
- data/lib/orb/type/unknown.rb +56 -0
- data/lib/orb/type.rb +23 -0
- data/lib/orb/util.rb +722 -0
- data/lib/orb/version.rb +5 -0
- data/lib/orb.rb +247 -0
- data/manifest.yaml +15 -0
- data/rbi/lib/orb/client.rbi +90 -0
- data/rbi/lib/orb/errors.rbi +246 -0
- data/rbi/lib/orb/models/alert.rbi +239 -0
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +86 -0
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +88 -0
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +83 -0
- data/rbi/lib/orb/models/alert_disable_params.rbi +28 -0
- data/rbi/lib/orb/models/alert_enable_params.rbi +28 -0
- data/rbi/lib/orb/models/alert_list_params.rbi +95 -0
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +20 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +51 -0
- data/rbi/lib/orb/models/amount_discount.rbi +62 -0
- data/rbi/lib/orb/models/billable_metric.rbi +83 -0
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +19 -0
- data/rbi/lib/orb/models/coupon.rbi +90 -0
- data/rbi/lib/orb/models/coupon_archive_params.rbi +20 -0
- data/rbi/lib/orb/models/coupon_create_params.rbi +120 -0
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/coupon_list_params.rbi +59 -0
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +41 -0
- data/rbi/lib/orb/models/credit_note.rbi +546 -0
- data/rbi/lib/orb/models/credit_note_create_params.rbi +84 -0
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/credit_note_list_params.rbi +74 -0
- data/rbi/lib/orb/models/customer.rbi +941 -0
- data/rbi/lib/orb/models/customer_create_params.rbi +923 -0
- data/rbi/lib/orb/models/customer_delete_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_list_params.rbi +74 -0
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +945 -0
- data/rbi/lib/orb/models/customer_update_params.rbi +919 -0
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +64 -0
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +199 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +76 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +191 -0
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +86 -0
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +214 -0
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +84 -0
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +212 -0
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +64 -0
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +87 -0
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +64 -0
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +86 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +270 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +1670 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +238 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +1626 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +181 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +1654 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +144 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +1588 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +196 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +198 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +176 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +175 -0
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +31 -0
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +28 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +49 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +188 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +49 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +168 -0
- data/rbi/lib/orb/models/dimensional_price_group.rbi +75 -0
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +66 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +39 -0
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +20 -0
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +22 -0
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +35 -0
- data/rbi/lib/orb/models/discount.rbi +18 -0
- data/rbi/lib/orb/models/evaluate_price_group.rbi +45 -0
- data/rbi/lib/orb/models/event_deprecate_params.rbi +20 -0
- data/rbi/lib/orb/models/event_deprecate_response.rbi +19 -0
- data/rbi/lib/orb/models/event_ingest_params.rbi +120 -0
- data/rbi/lib/orb/models/event_ingest_response.rbi +79 -0
- data/rbi/lib/orb/models/event_search_params.rbi +53 -0
- data/rbi/lib/orb/models/event_search_response.rbi +100 -0
- data/rbi/lib/orb/models/event_update_params.rbi +71 -0
- data/rbi/lib/orb/models/event_update_response.rbi +19 -0
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +22 -0
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +127 -0
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +97 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +128 -0
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +22 -0
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +127 -0
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +41 -0
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +127 -0
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +22 -0
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +128 -0
- data/rbi/lib/orb/models/events/event_volumes.rbi +47 -0
- data/rbi/lib/orb/models/events/volume_list_params.rbi +69 -0
- data/rbi/lib/orb/models/invoice.rbi +2466 -0
- data/rbi/lib/orb/models/invoice_create_params.rbi +230 -0
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +24 -0
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +2646 -0
- data/rbi/lib/orb/models/invoice_issue_params.rbi +32 -0
- data/rbi/lib/orb/models/invoice_level_discount.rbi +16 -0
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +67 -0
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +1164 -0
- data/rbi/lib/orb/models/invoice_list_params.rbi +187 -0
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +48 -0
- data/rbi/lib/orb/models/invoice_pay_params.rbi +20 -0
- data/rbi/lib/orb/models/invoice_update_params.rbi +36 -0
- data/rbi/lib/orb/models/invoice_void_params.rbi +20 -0
- data/rbi/lib/orb/models/item.rbi +101 -0
- data/rbi/lib/orb/models/item_create_params.rbi +25 -0
- data/rbi/lib/orb/models/item_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/item_list_params.rbi +39 -0
- data/rbi/lib/orb/models/item_update_params.rbi +113 -0
- data/rbi/lib/orb/models/metric_create_params.rbi +62 -0
- data/rbi/lib/orb/models/metric_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/metric_list_params.rbi +74 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +36 -0
- data/rbi/lib/orb/models/pagination_metadata.rbi +21 -0
- data/rbi/lib/orb/models/percentage_discount.rbi +63 -0
- data/rbi/lib/orb/models/plan.rbi +1071 -0
- data/rbi/lib/orb/models/plan_create_params.rbi +10069 -0
- data/rbi/lib/orb/models/plan_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/plan_list_params.rbi +100 -0
- data/rbi/lib/orb/models/plan_update_params.rbi +46 -0
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +22 -0
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +48 -0
- data/rbi/lib/orb/models/price.rbi +15341 -0
- data/rbi/lib/orb/models/price_create_params.rbi +885 -0
- data/rbi/lib/orb/models/price_evaluate_params.rbi +81 -0
- data/rbi/lib/orb/models/price_evaluate_response.rbi +21 -0
- data/rbi/lib/orb/models/price_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/price_list_params.rbi +39 -0
- data/rbi/lib/orb/models/price_update_params.rbi +36 -0
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +22 -0
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +38 -0
- data/rbi/lib/orb/models/subscription.rbi +1381 -0
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +75 -0
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +1374 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +23422 -0
- data/rbi/lib/orb/models/subscription_create_response.rbi +1374 -0
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +82 -0
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +210 -0
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +74 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +81 -0
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +137 -0
- data/rbi/lib/orb/models/subscription_list_params.rbi +108 -0
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +12991 -0
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +1387 -0
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +23589 -0
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +1390 -0
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +45 -0
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +1381 -0
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +20 -0
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +1400 -0
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +25 -0
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1451 -0
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +20 -0
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1410 -0
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +104 -0
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1400 -0
- data/rbi/lib/orb/models/subscription_update_params.rbi +77 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +63 -0
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +1378 -0
- data/rbi/lib/orb/models/subscription_usage.rbi +323 -0
- data/rbi/lib/orb/models/subscriptions.rbi +33 -0
- data/rbi/lib/orb/models/top_level_ping_params.rbi +20 -0
- data/rbi/lib/orb/models/top_level_ping_response.rbi +18 -0
- data/rbi/lib/orb/models/trial_discount.rbi +73 -0
- data/rbi/lib/orb/models/usage_discount.rbi +62 -0
- data/rbi/lib/orb/page.rbi +35 -0
- data/rbi/lib/orb/request_options.rbi +48 -0
- data/rbi/lib/orb/resources/alerts.rbi +216 -0
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +38 -0
- data/rbi/lib/orb/resources/coupons.rbi +96 -0
- data/rbi/lib/orb/resources/credit_notes.rbi +74 -0
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +92 -0
- data/rbi/lib/orb/resources/customers/costs.rbi +304 -0
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +645 -0
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +180 -0
- data/rbi/lib/orb/resources/customers/credits.rbi +88 -0
- data/rbi/lib/orb/resources/customers.rbi +714 -0
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +25 -0
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +78 -0
- data/rbi/lib/orb/resources/events/backfills.rbi +161 -0
- data/rbi/lib/orb/resources/events/volume.rbi +57 -0
- data/rbi/lib/orb/resources/events.rbi +408 -0
- data/rbi/lib/orb/resources/invoice_line_items.rbi +44 -0
- data/rbi/lib/orb/resources/invoices.rbi +262 -0
- data/rbi/lib/orb/resources/items.rbi +65 -0
- data/rbi/lib/orb/resources/metrics.rbi +102 -0
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +67 -0
- data/rbi/lib/orb/resources/plans.rbi +170 -0
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +110 -0
- data/rbi/lib/orb/resources/prices.rbi +371 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +1469 -0
- data/rbi/lib/orb/resources/top_level.rbi +25 -0
- data/rbi/lib/orb/transport/base_client.rbi +205 -0
- data/rbi/lib/orb/transport/pooled_net_requester.rbi +64 -0
- data/rbi/lib/orb/type/array_of.rbi +82 -0
- data/rbi/lib/orb/type/base_model.rbi +197 -0
- data/rbi/lib/orb/type/base_page.rbi +38 -0
- data/rbi/lib/orb/type/boolean_model.rbi +41 -0
- data/rbi/lib/orb/type/converter.rbi +95 -0
- data/rbi/lib/orb/type/enum.rbi +58 -0
- data/rbi/lib/orb/type/hash_of.rbi +86 -0
- data/rbi/lib/orb/type/request_parameters.rbi +20 -0
- data/rbi/lib/orb/type/union.rbi +66 -0
- data/rbi/lib/orb/type/unknown.rbi +37 -0
- data/rbi/lib/orb/type.rbi +23 -0
- data/rbi/lib/orb/util.rbi +278 -0
- data/rbi/lib/orb/version.rbi +5 -0
- data/sig/orb/client.rbs +53 -0
- data/sig/orb/errors.rbs +201 -0
- data/sig/orb/models/alert.rbs +142 -0
- data/sig/orb/models/alert_create_for_customer_params.rbs +56 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +56 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +52 -0
- data/sig/orb/models/alert_disable_params.rbs +20 -0
- data/sig/orb/models/alert_enable_params.rbs +20 -0
- data/sig/orb/models/alert_list_params.rbs +57 -0
- data/sig/orb/models/alert_retrieve_params.rbs +14 -0
- data/sig/orb/models/alert_update_params.rbs +31 -0
- data/sig/orb/models/amount_discount.rbs +40 -0
- data/sig/orb/models/billable_metric.rbs +50 -0
- data/sig/orb/models/billing_cycle_relative_date.rbs +14 -0
- data/sig/orb/models/coupon.rbs +51 -0
- data/sig/orb/models/coupon_archive_params.rbs +14 -0
- data/sig/orb/models/coupon_create_params.rbs +77 -0
- data/sig/orb/models/coupon_fetch_params.rbs +14 -0
- data/sig/orb/models/coupon_list_params.rbs +37 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +27 -0
- data/sig/orb/models/credit_note.rbs +345 -0
- data/sig/orb/models/credit_note_create_params.rbs +57 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +14 -0
- data/sig/orb/models/credit_note_list_params.rbs +45 -0
- data/sig/orb/models/customer.rbs +628 -0
- data/sig/orb/models/customer_create_params.rbs +624 -0
- data/sig/orb/models/customer_delete_params.rbs +14 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customer_fetch_params.rbs +14 -0
- data/sig/orb/models/customer_list_params.rbs +45 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +15 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +15 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +620 -0
- data/sig/orb/models/customer_update_params.rbs +620 -0
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +44 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +114 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +47 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +114 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +48 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +82 -0
- data/sig/orb/models/customers/cost_list_params.rbs +48 -0
- data/sig/orb/models/customers/cost_list_response.rbs +80 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +41 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +55 -0
- data/sig/orb/models/customers/credit_list_params.rbs +41 -0
- data/sig/orb/models/customers/credit_list_response.rbs +55 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +120 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +814 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +120 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +814 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +99 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +814 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +99 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +814 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +95 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +90 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +95 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +90 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +24 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +24 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +29 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +90 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +29 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +90 -0
- data/sig/orb/models/dimensional_price_group.rbs +38 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +39 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +25 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +15 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +17 -0
- data/sig/orb/models/dimensional_price_groups.rbs +22 -0
- data/sig/orb/models/discount.rbs +15 -0
- data/sig/orb/models/evaluate_price_group.rbs +34 -0
- data/sig/orb/models/event_deprecate_params.rbs +14 -0
- data/sig/orb/models/event_deprecate_response.rbs +13 -0
- data/sig/orb/models/event_ingest_params.rbs +68 -0
- data/sig/orb/models/event_ingest_response.rbs +53 -0
- data/sig/orb/models/event_search_params.rbs +31 -0
- data/sig/orb/models/event_search_response.rbs +55 -0
- data/sig/orb/models/event_update_params.rbs +39 -0
- data/sig/orb/models/event_update_response.rbs +13 -0
- data/sig/orb/models/events/backfill_close_params.rbs +16 -0
- data/sig/orb/models/events/backfill_close_response.rbs +73 -0
- data/sig/orb/models/events/backfill_create_params.rbs +51 -0
- data/sig/orb/models/events/backfill_create_response.rbs +73 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +16 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +73 -0
- data/sig/orb/models/events/backfill_list_params.rbs +27 -0
- data/sig/orb/models/events/backfill_list_response.rbs +73 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +16 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +73 -0
- data/sig/orb/models/events/event_volumes.rbs +39 -0
- data/sig/orb/models/events/volume_list_params.rbs +41 -0
- data/sig/orb/models/invoice.rbs +1430 -0
- data/sig/orb/models/invoice_create_params.rbs +120 -0
- data/sig/orb/models/invoice_fetch_params.rbs +14 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +20 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +1430 -0
- data/sig/orb/models/invoice_issue_params.rbs +21 -0
- data/sig/orb/models/invoice_level_discount.rbs +14 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +43 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +546 -0
- data/sig/orb/models/invoice_list_params.rbs +122 -0
- data/sig/orb/models/invoice_mark_paid_params.rbs +27 -0
- data/sig/orb/models/invoice_pay_params.rbs +14 -0
- data/sig/orb/models/invoice_update_params.rbs +20 -0
- data/sig/orb/models/invoice_void_params.rbs +14 -0
- data/sig/orb/models/item.rbs +72 -0
- data/sig/orb/models/item_create_params.rbs +19 -0
- data/sig/orb/models/item_fetch_params.rbs +14 -0
- data/sig/orb/models/item_list_params.rbs +25 -0
- data/sig/orb/models/item_update_params.rbs +69 -0
- data/sig/orb/models/metric_create_params.rbs +39 -0
- data/sig/orb/models/metric_fetch_params.rbs +14 -0
- data/sig/orb/models/metric_list_params.rbs +45 -0
- data/sig/orb/models/metric_update_params.rbs +20 -0
- data/sig/orb/models/pagination_metadata.rbs +15 -0
- data/sig/orb/models/percentage_discount.rbs +40 -0
- data/sig/orb/models/plan.rbs +529 -0
- data/sig/orb/models/plan_create_params.rbs +3991 -0
- data/sig/orb/models/plan_fetch_params.rbs +14 -0
- data/sig/orb/models/plan_list_params.rbs +65 -0
- data/sig/orb/models/plan_update_params.rbs +24 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +16 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +26 -0
- data/sig/orb/models/price.rbs +8108 -0
- data/sig/orb/models/price_create_params.rbs +520 -0
- data/sig/orb/models/price_evaluate_params.rbs +45 -0
- data/sig/orb/models/price_evaluate_response.rbs +14 -0
- data/sig/orb/models/price_fetch_params.rbs +14 -0
- data/sig/orb/models/price_list_params.rbs +25 -0
- data/sig/orb/models/price_update_params.rbs +20 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +16 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +22 -0
- data/sig/orb/models/subscription.rbs +687 -0
- data/sig/orb/models/subscription_cancel_params.rbs +44 -0
- data/sig/orb/models/subscription_cancel_response.rbs +687 -0
- data/sig/orb/models/subscription_create_params.rbs +9141 -0
- data/sig/orb/models/subscription_create_response.rbs +687 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +46 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +78 -0
- data/sig/orb/models/subscription_fetch_params.rbs +14 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +45 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +48 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +80 -0
- data/sig/orb/models/subscription_list_params.rbs +69 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +5117 -0
- data/sig/orb/models/subscription_price_intervals_response.rbs +687 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +9133 -0
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +687 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +24 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +687 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +15 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +687 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +20 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +687 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +15 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +687 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +55 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +687 -0
- data/sig/orb/models/subscription_update_params.rbs +39 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +39 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +687 -0
- data/sig/orb/models/subscription_usage.rbs +196 -0
- data/sig/orb/models/subscriptions.rbs +22 -0
- data/sig/orb/models/top_level_ping_params.rbs +14 -0
- data/sig/orb/models/top_level_ping_response.rbs +13 -0
- data/sig/orb/models/trial_discount.rbs +44 -0
- data/sig/orb/models/usage_discount.rbs +40 -0
- data/sig/orb/page.rbs +22 -0
- data/sig/orb/request_options.rbs +32 -0
- data/sig/orb/resources/alerts.rbs +67 -0
- data/sig/orb/resources/coupons/subscriptions.rbs +16 -0
- data/sig/orb/resources/coupons.rbs +35 -0
- data/sig/orb/resources/credit_notes.rbs +29 -0
- data/sig/orb/resources/customers/balance_transactions.rbs +28 -0
- data/sig/orb/resources/customers/costs.rbs +27 -0
- data/sig/orb/resources/customers/credits/ledger.rbs +75 -0
- data/sig/orb/resources/customers/credits/top_ups.rbs +63 -0
- data/sig/orb/resources/customers/credits.rbs +31 -0
- data/sig/orb/resources/customers.rbs +114 -0
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +14 -0
- data/sig/orb/resources/dimensional_price_groups.rbs +29 -0
- data/sig/orb/resources/events/backfills.rbs +41 -0
- data/sig/orb/resources/events/volume.rbs +17 -0
- data/sig/orb/resources/events.rbs +40 -0
- data/sig/orb/resources/invoice_line_items.rbs +17 -0
- data/sig/orb/resources/invoices.rbs +84 -0
- data/sig/orb/resources/items.rbs +30 -0
- data/sig/orb/resources/metrics.rbs +37 -0
- data/sig/orb/resources/plans/external_plan_id.rbs +21 -0
- data/sig/orb/resources/plans.rbs +44 -0
- data/sig/orb/resources/prices/external_price_id.rbs +20 -0
- data/sig/orb/resources/prices.rbs +83 -0
- data/sig/orb/resources/subscriptions.rbs +194 -0
- data/sig/orb/resources/top_level.rbs +11 -0
- data/sig/orb/transport/base_client.rbs +110 -0
- data/sig/orb/transport/pooled_net_requester.rbs +39 -0
- data/sig/orb/type/array_of.rbs +36 -0
- data/sig/orb/type/base_model.rbs +77 -0
- data/sig/orb/type/base_page.rbs +22 -0
- data/sig/orb/type/boolean_model.rbs +18 -0
- data/sig/orb/type/converter.rbs +36 -0
- data/sig/orb/type/enum.rbs +22 -0
- data/sig/orb/type/hash_of.rbs +36 -0
- data/sig/orb/type/request_parameters.rbs +13 -0
- data/sig/orb/type/union.rbs +37 -0
- data/sig/orb/type/unknown.rbs +15 -0
- data/sig/orb/type.rbs +22 -0
- data/sig/orb/util.rbs +132 -0
- data/sig/orb/version.rbs +3 -0
- metadata +692 -0
@@ -0,0 +1,885 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
class PriceCreateParams < Orb::BaseModel
|
6
|
+
extend Orb::Type::RequestParameters::Converter
|
7
|
+
include Orb::RequestParameters
|
8
|
+
|
9
|
+
# The cadence to bill for this price on.
|
10
|
+
sig { returns(Orb::Models::PriceCreateParams::Cadence::OrSymbol) }
|
11
|
+
attr_accessor :cadence
|
12
|
+
|
13
|
+
# An ISO 4217 currency string for which this price is billed in.
|
14
|
+
sig { returns(String) }
|
15
|
+
attr_accessor :currency
|
16
|
+
|
17
|
+
# The id of the item the price will be associated with.
|
18
|
+
sig { returns(String) }
|
19
|
+
attr_accessor :item_id
|
20
|
+
|
21
|
+
sig { returns(Orb::Models::PriceCreateParams::ModelType::OrSymbol) }
|
22
|
+
attr_accessor :model_type
|
23
|
+
|
24
|
+
# The name of the price.
|
25
|
+
sig { returns(String) }
|
26
|
+
attr_accessor :name
|
27
|
+
|
28
|
+
sig { returns(Orb::Models::PriceCreateParams::UnitConfig) }
|
29
|
+
attr_reader :unit_config
|
30
|
+
|
31
|
+
sig { params(unit_config: T.any(Orb::Models::PriceCreateParams::UnitConfig, Orb::Util::AnyHash)).void }
|
32
|
+
attr_writer :unit_config
|
33
|
+
|
34
|
+
# The id of the billable metric for the price. Only needed if the price is
|
35
|
+
# usage-based.
|
36
|
+
sig { returns(T.nilable(String)) }
|
37
|
+
attr_accessor :billable_metric_id
|
38
|
+
|
39
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
40
|
+
# this is true, and in-arrears if this is false.
|
41
|
+
sig { returns(T.nilable(T::Boolean)) }
|
42
|
+
attr_accessor :billed_in_advance
|
43
|
+
|
44
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
45
|
+
# months.
|
46
|
+
sig { returns(T.nilable(Orb::Models::PriceCreateParams::BillingCycleConfiguration)) }
|
47
|
+
attr_reader :billing_cycle_configuration
|
48
|
+
|
49
|
+
sig do
|
50
|
+
params(
|
51
|
+
billing_cycle_configuration: T.nilable(T.any(Orb::Models::PriceCreateParams::BillingCycleConfiguration, Orb::Util::AnyHash))
|
52
|
+
)
|
53
|
+
.void
|
54
|
+
end
|
55
|
+
attr_writer :billing_cycle_configuration
|
56
|
+
|
57
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
58
|
+
sig { returns(T.nilable(Float)) }
|
59
|
+
attr_accessor :conversion_rate
|
60
|
+
|
61
|
+
# An alias for the price.
|
62
|
+
sig { returns(T.nilable(String)) }
|
63
|
+
attr_accessor :external_price_id
|
64
|
+
|
65
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
66
|
+
# applied.
|
67
|
+
sig { returns(T.nilable(Float)) }
|
68
|
+
attr_accessor :fixed_price_quantity
|
69
|
+
|
70
|
+
# The property used to group this price on an invoice
|
71
|
+
sig { returns(T.nilable(String)) }
|
72
|
+
attr_accessor :invoice_grouping_key
|
73
|
+
|
74
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
75
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
76
|
+
sig { returns(T.nilable(Orb::Models::PriceCreateParams::InvoicingCycleConfiguration)) }
|
77
|
+
attr_reader :invoicing_cycle_configuration
|
78
|
+
|
79
|
+
sig do
|
80
|
+
params(
|
81
|
+
invoicing_cycle_configuration: T.nilable(T.any(Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, Orb::Util::AnyHash))
|
82
|
+
)
|
83
|
+
.void
|
84
|
+
end
|
85
|
+
attr_writer :invoicing_cycle_configuration
|
86
|
+
|
87
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
88
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
89
|
+
# by setting `metadata` to `null`.
|
90
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
|
91
|
+
attr_accessor :metadata
|
92
|
+
|
93
|
+
sig { returns(Orb::Models::PriceCreateParams::PackageConfig) }
|
94
|
+
attr_reader :package_config
|
95
|
+
|
96
|
+
sig { params(package_config: T.any(Orb::Models::PriceCreateParams::PackageConfig, Orb::Util::AnyHash)).void }
|
97
|
+
attr_writer :package_config
|
98
|
+
|
99
|
+
sig { returns(Orb::Models::PriceCreateParams::MatrixConfig) }
|
100
|
+
attr_reader :matrix_config
|
101
|
+
|
102
|
+
sig { params(matrix_config: T.any(Orb::Models::PriceCreateParams::MatrixConfig, Orb::Util::AnyHash)).void }
|
103
|
+
attr_writer :matrix_config
|
104
|
+
|
105
|
+
sig { returns(Orb::Models::PriceCreateParams::MatrixWithAllocationConfig) }
|
106
|
+
attr_reader :matrix_with_allocation_config
|
107
|
+
|
108
|
+
sig do
|
109
|
+
params(
|
110
|
+
matrix_with_allocation_config: T.any(Orb::Models::PriceCreateParams::MatrixWithAllocationConfig, Orb::Util::AnyHash)
|
111
|
+
)
|
112
|
+
.void
|
113
|
+
end
|
114
|
+
attr_writer :matrix_with_allocation_config
|
115
|
+
|
116
|
+
sig { returns(Orb::Models::PriceCreateParams::TieredConfig) }
|
117
|
+
attr_reader :tiered_config
|
118
|
+
|
119
|
+
sig { params(tiered_config: T.any(Orb::Models::PriceCreateParams::TieredConfig, Orb::Util::AnyHash)).void }
|
120
|
+
attr_writer :tiered_config
|
121
|
+
|
122
|
+
sig { returns(Orb::Models::PriceCreateParams::TieredBpsConfig) }
|
123
|
+
attr_reader :tiered_bps_config
|
124
|
+
|
125
|
+
sig { params(tiered_bps_config: T.any(Orb::Models::PriceCreateParams::TieredBpsConfig, Orb::Util::AnyHash)).void }
|
126
|
+
attr_writer :tiered_bps_config
|
127
|
+
|
128
|
+
sig { returns(Orb::Models::PriceCreateParams::BpsConfig) }
|
129
|
+
attr_reader :bps_config
|
130
|
+
|
131
|
+
sig { params(bps_config: T.any(Orb::Models::PriceCreateParams::BpsConfig, Orb::Util::AnyHash)).void }
|
132
|
+
attr_writer :bps_config
|
133
|
+
|
134
|
+
sig { returns(Orb::Models::PriceCreateParams::BulkBpsConfig) }
|
135
|
+
attr_reader :bulk_bps_config
|
136
|
+
|
137
|
+
sig { params(bulk_bps_config: T.any(Orb::Models::PriceCreateParams::BulkBpsConfig, Orb::Util::AnyHash)).void }
|
138
|
+
attr_writer :bulk_bps_config
|
139
|
+
|
140
|
+
sig { returns(Orb::Models::PriceCreateParams::BulkConfig) }
|
141
|
+
attr_reader :bulk_config
|
142
|
+
|
143
|
+
sig { params(bulk_config: T.any(Orb::Models::PriceCreateParams::BulkConfig, Orb::Util::AnyHash)).void }
|
144
|
+
attr_writer :bulk_config
|
145
|
+
|
146
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
147
|
+
attr_accessor :threshold_total_amount_config
|
148
|
+
|
149
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
150
|
+
attr_accessor :tiered_package_config
|
151
|
+
|
152
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
153
|
+
attr_accessor :grouped_tiered_config
|
154
|
+
|
155
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
156
|
+
attr_accessor :max_group_tiered_package_config
|
157
|
+
|
158
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
159
|
+
attr_accessor :tiered_with_minimum_config
|
160
|
+
|
161
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
162
|
+
attr_accessor :package_with_allocation_config
|
163
|
+
|
164
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
165
|
+
attr_accessor :tiered_package_with_minimum_config
|
166
|
+
|
167
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
168
|
+
attr_accessor :unit_with_percent_config
|
169
|
+
|
170
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
171
|
+
attr_accessor :tiered_with_proration_config
|
172
|
+
|
173
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
174
|
+
attr_accessor :unit_with_proration_config
|
175
|
+
|
176
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
177
|
+
attr_accessor :grouped_allocation_config
|
178
|
+
|
179
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
180
|
+
attr_accessor :grouped_with_prorated_minimum_config
|
181
|
+
|
182
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
183
|
+
attr_accessor :grouped_with_metered_minimum_config
|
184
|
+
|
185
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
186
|
+
attr_accessor :matrix_with_display_name_config
|
187
|
+
|
188
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
189
|
+
attr_accessor :bulk_with_proration_config
|
190
|
+
|
191
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
192
|
+
attr_accessor :grouped_tiered_package_config
|
193
|
+
|
194
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
195
|
+
attr_accessor :scalable_matrix_with_unit_pricing_config
|
196
|
+
|
197
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
198
|
+
attr_accessor :scalable_matrix_with_tiered_pricing_config
|
199
|
+
|
200
|
+
sig { returns(T::Hash[Symbol, T.anything]) }
|
201
|
+
attr_accessor :cumulative_grouped_bulk_config
|
202
|
+
|
203
|
+
sig do
|
204
|
+
params(
|
205
|
+
cadence: Orb::Models::PriceCreateParams::Cadence::OrSymbol,
|
206
|
+
currency: String,
|
207
|
+
item_id: String,
|
208
|
+
model_type: Orb::Models::PriceCreateParams::ModelType::OrSymbol,
|
209
|
+
name: String,
|
210
|
+
unit_config: T.any(Orb::Models::PriceCreateParams::UnitConfig, Orb::Util::AnyHash),
|
211
|
+
package_config: T.any(Orb::Models::PriceCreateParams::PackageConfig, Orb::Util::AnyHash),
|
212
|
+
matrix_config: T.any(Orb::Models::PriceCreateParams::MatrixConfig, Orb::Util::AnyHash),
|
213
|
+
matrix_with_allocation_config: T.any(Orb::Models::PriceCreateParams::MatrixWithAllocationConfig, Orb::Util::AnyHash),
|
214
|
+
tiered_config: T.any(Orb::Models::PriceCreateParams::TieredConfig, Orb::Util::AnyHash),
|
215
|
+
tiered_bps_config: T.any(Orb::Models::PriceCreateParams::TieredBpsConfig, Orb::Util::AnyHash),
|
216
|
+
bps_config: T.any(Orb::Models::PriceCreateParams::BpsConfig, Orb::Util::AnyHash),
|
217
|
+
bulk_bps_config: T.any(Orb::Models::PriceCreateParams::BulkBpsConfig, Orb::Util::AnyHash),
|
218
|
+
bulk_config: T.any(Orb::Models::PriceCreateParams::BulkConfig, Orb::Util::AnyHash),
|
219
|
+
threshold_total_amount_config: T::Hash[Symbol, T.anything],
|
220
|
+
tiered_package_config: T::Hash[Symbol, T.anything],
|
221
|
+
grouped_tiered_config: T::Hash[Symbol, T.anything],
|
222
|
+
max_group_tiered_package_config: T::Hash[Symbol, T.anything],
|
223
|
+
tiered_with_minimum_config: T::Hash[Symbol, T.anything],
|
224
|
+
package_with_allocation_config: T::Hash[Symbol, T.anything],
|
225
|
+
tiered_package_with_minimum_config: T::Hash[Symbol, T.anything],
|
226
|
+
unit_with_percent_config: T::Hash[Symbol, T.anything],
|
227
|
+
tiered_with_proration_config: T::Hash[Symbol, T.anything],
|
228
|
+
unit_with_proration_config: T::Hash[Symbol, T.anything],
|
229
|
+
grouped_allocation_config: T::Hash[Symbol, T.anything],
|
230
|
+
grouped_with_prorated_minimum_config: T::Hash[Symbol, T.anything],
|
231
|
+
grouped_with_metered_minimum_config: T::Hash[Symbol, T.anything],
|
232
|
+
matrix_with_display_name_config: T::Hash[Symbol, T.anything],
|
233
|
+
bulk_with_proration_config: T::Hash[Symbol, T.anything],
|
234
|
+
grouped_tiered_package_config: T::Hash[Symbol, T.anything],
|
235
|
+
scalable_matrix_with_unit_pricing_config: T::Hash[Symbol, T.anything],
|
236
|
+
scalable_matrix_with_tiered_pricing_config: T::Hash[Symbol, T.anything],
|
237
|
+
cumulative_grouped_bulk_config: T::Hash[Symbol, T.anything],
|
238
|
+
billable_metric_id: T.nilable(String),
|
239
|
+
billed_in_advance: T.nilable(T::Boolean),
|
240
|
+
billing_cycle_configuration: T.nilable(T.any(Orb::Models::PriceCreateParams::BillingCycleConfiguration, Orb::Util::AnyHash)),
|
241
|
+
conversion_rate: T.nilable(Float),
|
242
|
+
external_price_id: T.nilable(String),
|
243
|
+
fixed_price_quantity: T.nilable(Float),
|
244
|
+
invoice_grouping_key: T.nilable(String),
|
245
|
+
invoicing_cycle_configuration: T.nilable(T.any(Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, Orb::Util::AnyHash)),
|
246
|
+
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
247
|
+
request_options: T.any(Orb::RequestOptions, Orb::Util::AnyHash)
|
248
|
+
)
|
249
|
+
.returns(T.attached_class)
|
250
|
+
end
|
251
|
+
def self.new(
|
252
|
+
cadence:,
|
253
|
+
currency:,
|
254
|
+
item_id:,
|
255
|
+
model_type:,
|
256
|
+
name:,
|
257
|
+
unit_config:,
|
258
|
+
package_config:,
|
259
|
+
matrix_config:,
|
260
|
+
matrix_with_allocation_config:,
|
261
|
+
tiered_config:,
|
262
|
+
tiered_bps_config:,
|
263
|
+
bps_config:,
|
264
|
+
bulk_bps_config:,
|
265
|
+
bulk_config:,
|
266
|
+
threshold_total_amount_config:,
|
267
|
+
tiered_package_config:,
|
268
|
+
grouped_tiered_config:,
|
269
|
+
max_group_tiered_package_config:,
|
270
|
+
tiered_with_minimum_config:,
|
271
|
+
package_with_allocation_config:,
|
272
|
+
tiered_package_with_minimum_config:,
|
273
|
+
unit_with_percent_config:,
|
274
|
+
tiered_with_proration_config:,
|
275
|
+
unit_with_proration_config:,
|
276
|
+
grouped_allocation_config:,
|
277
|
+
grouped_with_prorated_minimum_config:,
|
278
|
+
grouped_with_metered_minimum_config:,
|
279
|
+
matrix_with_display_name_config:,
|
280
|
+
bulk_with_proration_config:,
|
281
|
+
grouped_tiered_package_config:,
|
282
|
+
scalable_matrix_with_unit_pricing_config:,
|
283
|
+
scalable_matrix_with_tiered_pricing_config:,
|
284
|
+
cumulative_grouped_bulk_config:,
|
285
|
+
billable_metric_id: nil,
|
286
|
+
billed_in_advance: nil,
|
287
|
+
billing_cycle_configuration: nil,
|
288
|
+
conversion_rate: nil,
|
289
|
+
external_price_id: nil,
|
290
|
+
fixed_price_quantity: nil,
|
291
|
+
invoice_grouping_key: nil,
|
292
|
+
invoicing_cycle_configuration: nil,
|
293
|
+
metadata: nil,
|
294
|
+
request_options: {}
|
295
|
+
)
|
296
|
+
end
|
297
|
+
|
298
|
+
sig do
|
299
|
+
override
|
300
|
+
.returns(
|
301
|
+
{
|
302
|
+
cadence: Orb::Models::PriceCreateParams::Cadence::OrSymbol,
|
303
|
+
currency: String,
|
304
|
+
item_id: String,
|
305
|
+
model_type: Orb::Models::PriceCreateParams::ModelType::OrSymbol,
|
306
|
+
name: String,
|
307
|
+
unit_config: Orb::Models::PriceCreateParams::UnitConfig,
|
308
|
+
billable_metric_id: T.nilable(String),
|
309
|
+
billed_in_advance: T.nilable(T::Boolean),
|
310
|
+
billing_cycle_configuration: T.nilable(Orb::Models::PriceCreateParams::BillingCycleConfiguration),
|
311
|
+
conversion_rate: T.nilable(Float),
|
312
|
+
external_price_id: T.nilable(String),
|
313
|
+
fixed_price_quantity: T.nilable(Float),
|
314
|
+
invoice_grouping_key: T.nilable(String),
|
315
|
+
invoicing_cycle_configuration: T.nilable(Orb::Models::PriceCreateParams::InvoicingCycleConfiguration),
|
316
|
+
metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
|
317
|
+
package_config: Orb::Models::PriceCreateParams::PackageConfig,
|
318
|
+
matrix_config: Orb::Models::PriceCreateParams::MatrixConfig,
|
319
|
+
matrix_with_allocation_config: Orb::Models::PriceCreateParams::MatrixWithAllocationConfig,
|
320
|
+
tiered_config: Orb::Models::PriceCreateParams::TieredConfig,
|
321
|
+
tiered_bps_config: Orb::Models::PriceCreateParams::TieredBpsConfig,
|
322
|
+
bps_config: Orb::Models::PriceCreateParams::BpsConfig,
|
323
|
+
bulk_bps_config: Orb::Models::PriceCreateParams::BulkBpsConfig,
|
324
|
+
bulk_config: Orb::Models::PriceCreateParams::BulkConfig,
|
325
|
+
threshold_total_amount_config: T::Hash[Symbol, T.anything],
|
326
|
+
tiered_package_config: T::Hash[Symbol, T.anything],
|
327
|
+
grouped_tiered_config: T::Hash[Symbol, T.anything],
|
328
|
+
max_group_tiered_package_config: T::Hash[Symbol, T.anything],
|
329
|
+
tiered_with_minimum_config: T::Hash[Symbol, T.anything],
|
330
|
+
package_with_allocation_config: T::Hash[Symbol, T.anything],
|
331
|
+
tiered_package_with_minimum_config: T::Hash[Symbol, T.anything],
|
332
|
+
unit_with_percent_config: T::Hash[Symbol, T.anything],
|
333
|
+
tiered_with_proration_config: T::Hash[Symbol, T.anything],
|
334
|
+
unit_with_proration_config: T::Hash[Symbol, T.anything],
|
335
|
+
grouped_allocation_config: T::Hash[Symbol, T.anything],
|
336
|
+
grouped_with_prorated_minimum_config: T::Hash[Symbol, T.anything],
|
337
|
+
grouped_with_metered_minimum_config: T::Hash[Symbol, T.anything],
|
338
|
+
matrix_with_display_name_config: T::Hash[Symbol, T.anything],
|
339
|
+
bulk_with_proration_config: T::Hash[Symbol, T.anything],
|
340
|
+
grouped_tiered_package_config: T::Hash[Symbol, T.anything],
|
341
|
+
scalable_matrix_with_unit_pricing_config: T::Hash[Symbol, T.anything],
|
342
|
+
scalable_matrix_with_tiered_pricing_config: T::Hash[Symbol, T.anything],
|
343
|
+
cumulative_grouped_bulk_config: T::Hash[Symbol, T.anything],
|
344
|
+
request_options: Orb::RequestOptions
|
345
|
+
}
|
346
|
+
)
|
347
|
+
end
|
348
|
+
def to_hash
|
349
|
+
end
|
350
|
+
|
351
|
+
# The cadence to bill for this price on.
|
352
|
+
module Cadence
|
353
|
+
extend Orb::Enum
|
354
|
+
|
355
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::Cadence) }
|
356
|
+
OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol) }
|
357
|
+
|
358
|
+
ANNUAL = T.let(:annual, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol)
|
359
|
+
SEMI_ANNUAL = T.let(:semi_annual, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol)
|
360
|
+
MONTHLY = T.let(:monthly, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol)
|
361
|
+
QUARTERLY = T.let(:quarterly, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol)
|
362
|
+
ONE_TIME = T.let(:one_time, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol)
|
363
|
+
CUSTOM = T.let(:custom, Orb::Models::PriceCreateParams::Cadence::TaggedSymbol)
|
364
|
+
|
365
|
+
sig { override.returns(T::Array[Orb::Models::PriceCreateParams::Cadence::TaggedSymbol]) }
|
366
|
+
def self.values
|
367
|
+
end
|
368
|
+
end
|
369
|
+
|
370
|
+
module ModelType
|
371
|
+
extend Orb::Enum
|
372
|
+
|
373
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::ModelType) }
|
374
|
+
OrSymbol =
|
375
|
+
T.type_alias { T.any(Symbol, String, Orb::Models::PriceCreateParams::ModelType::TaggedSymbol) }
|
376
|
+
|
377
|
+
CUMULATIVE_GROUPED_BULK =
|
378
|
+
T.let(:cumulative_grouped_bulk, Orb::Models::PriceCreateParams::ModelType::TaggedSymbol)
|
379
|
+
|
380
|
+
sig { override.returns(T::Array[Orb::Models::PriceCreateParams::ModelType::TaggedSymbol]) }
|
381
|
+
def self.values
|
382
|
+
end
|
383
|
+
end
|
384
|
+
|
385
|
+
class UnitConfig < Orb::BaseModel
|
386
|
+
# Rate per unit of usage
|
387
|
+
sig { returns(String) }
|
388
|
+
attr_accessor :unit_amount
|
389
|
+
|
390
|
+
sig { params(unit_amount: String).returns(T.attached_class) }
|
391
|
+
def self.new(unit_amount:)
|
392
|
+
end
|
393
|
+
|
394
|
+
sig { override.returns({unit_amount: String}) }
|
395
|
+
def to_hash
|
396
|
+
end
|
397
|
+
end
|
398
|
+
|
399
|
+
class BillingCycleConfiguration < Orb::BaseModel
|
400
|
+
# The duration of the billing period.
|
401
|
+
sig { returns(Integer) }
|
402
|
+
attr_accessor :duration
|
403
|
+
|
404
|
+
# The unit of billing period duration.
|
405
|
+
sig { returns(Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::OrSymbol) }
|
406
|
+
attr_accessor :duration_unit
|
407
|
+
|
408
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
409
|
+
# months.
|
410
|
+
sig do
|
411
|
+
params(
|
412
|
+
duration: Integer,
|
413
|
+
duration_unit: Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::OrSymbol
|
414
|
+
)
|
415
|
+
.returns(T.attached_class)
|
416
|
+
end
|
417
|
+
def self.new(duration:, duration_unit:)
|
418
|
+
end
|
419
|
+
|
420
|
+
sig do
|
421
|
+
override
|
422
|
+
.returns(
|
423
|
+
{
|
424
|
+
duration: Integer,
|
425
|
+
duration_unit: Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::OrSymbol
|
426
|
+
}
|
427
|
+
)
|
428
|
+
end
|
429
|
+
def to_hash
|
430
|
+
end
|
431
|
+
|
432
|
+
# The unit of billing period duration.
|
433
|
+
module DurationUnit
|
434
|
+
extend Orb::Enum
|
435
|
+
|
436
|
+
TaggedSymbol =
|
437
|
+
T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit) }
|
438
|
+
OrSymbol =
|
439
|
+
T.type_alias do
|
440
|
+
T.any(
|
441
|
+
Symbol,
|
442
|
+
String,
|
443
|
+
Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol
|
444
|
+
)
|
445
|
+
end
|
446
|
+
|
447
|
+
DAY = T.let(:day, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol)
|
448
|
+
MONTH =
|
449
|
+
T.let(:month, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol)
|
450
|
+
|
451
|
+
sig do
|
452
|
+
override
|
453
|
+
.returns(T::Array[Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit::TaggedSymbol])
|
454
|
+
end
|
455
|
+
def self.values
|
456
|
+
end
|
457
|
+
end
|
458
|
+
end
|
459
|
+
|
460
|
+
class InvoicingCycleConfiguration < Orb::BaseModel
|
461
|
+
# The duration of the billing period.
|
462
|
+
sig { returns(Integer) }
|
463
|
+
attr_accessor :duration
|
464
|
+
|
465
|
+
# The unit of billing period duration.
|
466
|
+
sig { returns(Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::OrSymbol) }
|
467
|
+
attr_accessor :duration_unit
|
468
|
+
|
469
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
470
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
471
|
+
sig do
|
472
|
+
params(
|
473
|
+
duration: Integer,
|
474
|
+
duration_unit: Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::OrSymbol
|
475
|
+
)
|
476
|
+
.returns(T.attached_class)
|
477
|
+
end
|
478
|
+
def self.new(duration:, duration_unit:)
|
479
|
+
end
|
480
|
+
|
481
|
+
sig do
|
482
|
+
override
|
483
|
+
.returns(
|
484
|
+
{
|
485
|
+
duration: Integer,
|
486
|
+
duration_unit: Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::OrSymbol
|
487
|
+
}
|
488
|
+
)
|
489
|
+
end
|
490
|
+
def to_hash
|
491
|
+
end
|
492
|
+
|
493
|
+
# The unit of billing period duration.
|
494
|
+
module DurationUnit
|
495
|
+
extend Orb::Enum
|
496
|
+
|
497
|
+
TaggedSymbol =
|
498
|
+
T.type_alias { T.all(Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit) }
|
499
|
+
OrSymbol =
|
500
|
+
T.type_alias do
|
501
|
+
T.any(
|
502
|
+
Symbol,
|
503
|
+
String,
|
504
|
+
Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
|
505
|
+
)
|
506
|
+
end
|
507
|
+
|
508
|
+
DAY =
|
509
|
+
T.let(:day, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol)
|
510
|
+
MONTH =
|
511
|
+
T.let(:month, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol)
|
512
|
+
|
513
|
+
sig do
|
514
|
+
override
|
515
|
+
.returns(T::Array[Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol])
|
516
|
+
end
|
517
|
+
def self.values
|
518
|
+
end
|
519
|
+
end
|
520
|
+
end
|
521
|
+
|
522
|
+
class PackageConfig < Orb::BaseModel
|
523
|
+
# A currency amount to rate usage by
|
524
|
+
sig { returns(String) }
|
525
|
+
attr_accessor :package_amount
|
526
|
+
|
527
|
+
# An integer amount to represent package size. For example, 1000 here would divide
|
528
|
+
# usage by 1000 before multiplying by package_amount in rating
|
529
|
+
sig { returns(Integer) }
|
530
|
+
attr_accessor :package_size
|
531
|
+
|
532
|
+
sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) }
|
533
|
+
def self.new(package_amount:, package_size:)
|
534
|
+
end
|
535
|
+
|
536
|
+
sig { override.returns({package_amount: String, package_size: Integer}) }
|
537
|
+
def to_hash
|
538
|
+
end
|
539
|
+
end
|
540
|
+
|
541
|
+
class MatrixConfig < Orb::BaseModel
|
542
|
+
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
543
|
+
sig { returns(String) }
|
544
|
+
attr_accessor :default_unit_amount
|
545
|
+
|
546
|
+
# One or two event property values to evaluate matrix groups by
|
547
|
+
sig { returns(T::Array[T.nilable(String)]) }
|
548
|
+
attr_accessor :dimensions
|
549
|
+
|
550
|
+
# Matrix values for specified matrix grouping keys
|
551
|
+
sig { returns(T::Array[Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue]) }
|
552
|
+
attr_accessor :matrix_values
|
553
|
+
|
554
|
+
sig do
|
555
|
+
params(
|
556
|
+
default_unit_amount: String,
|
557
|
+
dimensions: T::Array[T.nilable(String)],
|
558
|
+
matrix_values: T::Array[T.any(Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue, Orb::Util::AnyHash)]
|
559
|
+
)
|
560
|
+
.returns(T.attached_class)
|
561
|
+
end
|
562
|
+
def self.new(default_unit_amount:, dimensions:, matrix_values:)
|
563
|
+
end
|
564
|
+
|
565
|
+
sig do
|
566
|
+
override
|
567
|
+
.returns(
|
568
|
+
{
|
569
|
+
default_unit_amount: String,
|
570
|
+
dimensions: T::Array[T.nilable(String)],
|
571
|
+
matrix_values: T::Array[Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue]
|
572
|
+
}
|
573
|
+
)
|
574
|
+
end
|
575
|
+
def to_hash
|
576
|
+
end
|
577
|
+
|
578
|
+
class MatrixValue < Orb::BaseModel
|
579
|
+
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
580
|
+
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
581
|
+
# instance tier.
|
582
|
+
sig { returns(T::Array[T.nilable(String)]) }
|
583
|
+
attr_accessor :dimension_values
|
584
|
+
|
585
|
+
# Unit price for the specified dimension_values
|
586
|
+
sig { returns(String) }
|
587
|
+
attr_accessor :unit_amount
|
588
|
+
|
589
|
+
sig do
|
590
|
+
params(
|
591
|
+
dimension_values: T::Array[T.nilable(String)],
|
592
|
+
unit_amount: String
|
593
|
+
).returns(T.attached_class)
|
594
|
+
end
|
595
|
+
def self.new(dimension_values:, unit_amount:)
|
596
|
+
end
|
597
|
+
|
598
|
+
sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) }
|
599
|
+
def to_hash
|
600
|
+
end
|
601
|
+
end
|
602
|
+
end
|
603
|
+
|
604
|
+
class MatrixWithAllocationConfig < Orb::BaseModel
|
605
|
+
# Allocation to be used to calculate the price
|
606
|
+
sig { returns(Float) }
|
607
|
+
attr_accessor :allocation
|
608
|
+
|
609
|
+
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
610
|
+
sig { returns(String) }
|
611
|
+
attr_accessor :default_unit_amount
|
612
|
+
|
613
|
+
# One or two event property values to evaluate matrix groups by
|
614
|
+
sig { returns(T::Array[T.nilable(String)]) }
|
615
|
+
attr_accessor :dimensions
|
616
|
+
|
617
|
+
# Matrix values for specified matrix grouping keys
|
618
|
+
sig { returns(T::Array[Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue]) }
|
619
|
+
attr_accessor :matrix_values
|
620
|
+
|
621
|
+
sig do
|
622
|
+
params(
|
623
|
+
allocation: Float,
|
624
|
+
default_unit_amount: String,
|
625
|
+
dimensions: T::Array[T.nilable(String)],
|
626
|
+
matrix_values: T::Array[T.any(Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue, Orb::Util::AnyHash)]
|
627
|
+
)
|
628
|
+
.returns(T.attached_class)
|
629
|
+
end
|
630
|
+
def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:)
|
631
|
+
end
|
632
|
+
|
633
|
+
sig do
|
634
|
+
override
|
635
|
+
.returns(
|
636
|
+
{
|
637
|
+
allocation: Float,
|
638
|
+
default_unit_amount: String,
|
639
|
+
dimensions: T::Array[T.nilable(String)],
|
640
|
+
matrix_values: T::Array[Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue]
|
641
|
+
}
|
642
|
+
)
|
643
|
+
end
|
644
|
+
def to_hash
|
645
|
+
end
|
646
|
+
|
647
|
+
class MatrixValue < Orb::BaseModel
|
648
|
+
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
649
|
+
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
650
|
+
# instance tier.
|
651
|
+
sig { returns(T::Array[T.nilable(String)]) }
|
652
|
+
attr_accessor :dimension_values
|
653
|
+
|
654
|
+
# Unit price for the specified dimension_values
|
655
|
+
sig { returns(String) }
|
656
|
+
attr_accessor :unit_amount
|
657
|
+
|
658
|
+
sig do
|
659
|
+
params(
|
660
|
+
dimension_values: T::Array[T.nilable(String)],
|
661
|
+
unit_amount: String
|
662
|
+
).returns(T.attached_class)
|
663
|
+
end
|
664
|
+
def self.new(dimension_values:, unit_amount:)
|
665
|
+
end
|
666
|
+
|
667
|
+
sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) }
|
668
|
+
def to_hash
|
669
|
+
end
|
670
|
+
end
|
671
|
+
end
|
672
|
+
|
673
|
+
class TieredConfig < Orb::BaseModel
|
674
|
+
# Tiers for rating based on total usage quantities into the specified tier
|
675
|
+
sig { returns(T::Array[Orb::Models::PriceCreateParams::TieredConfig::Tier]) }
|
676
|
+
attr_accessor :tiers
|
677
|
+
|
678
|
+
sig do
|
679
|
+
params(tiers: T::Array[T.any(Orb::Models::PriceCreateParams::TieredConfig::Tier, Orb::Util::AnyHash)])
|
680
|
+
.returns(T.attached_class)
|
681
|
+
end
|
682
|
+
def self.new(tiers:)
|
683
|
+
end
|
684
|
+
|
685
|
+
sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::TieredConfig::Tier]}) }
|
686
|
+
def to_hash
|
687
|
+
end
|
688
|
+
|
689
|
+
class Tier < Orb::BaseModel
|
690
|
+
# Inclusive tier starting value
|
691
|
+
sig { returns(Float) }
|
692
|
+
attr_accessor :first_unit
|
693
|
+
|
694
|
+
# Amount per unit
|
695
|
+
sig { returns(String) }
|
696
|
+
attr_accessor :unit_amount
|
697
|
+
|
698
|
+
# Exclusive tier ending value. If null, this is treated as the last tier
|
699
|
+
sig { returns(T.nilable(Float)) }
|
700
|
+
attr_accessor :last_unit
|
701
|
+
|
702
|
+
sig do
|
703
|
+
params(
|
704
|
+
first_unit: Float,
|
705
|
+
unit_amount: String,
|
706
|
+
last_unit: T.nilable(Float)
|
707
|
+
).returns(T.attached_class)
|
708
|
+
end
|
709
|
+
def self.new(first_unit:, unit_amount:, last_unit: nil)
|
710
|
+
end
|
711
|
+
|
712
|
+
sig { override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)}) }
|
713
|
+
def to_hash
|
714
|
+
end
|
715
|
+
end
|
716
|
+
end
|
717
|
+
|
718
|
+
class TieredBpsConfig < Orb::BaseModel
|
719
|
+
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
720
|
+
# tiers
|
721
|
+
sig { returns(T::Array[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier]) }
|
722
|
+
attr_accessor :tiers
|
723
|
+
|
724
|
+
sig do
|
725
|
+
params(tiers: T::Array[T.any(Orb::Models::PriceCreateParams::TieredBpsConfig::Tier, Orb::Util::AnyHash)])
|
726
|
+
.returns(T.attached_class)
|
727
|
+
end
|
728
|
+
def self.new(tiers:)
|
729
|
+
end
|
730
|
+
|
731
|
+
sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier]}) }
|
732
|
+
def to_hash
|
733
|
+
end
|
734
|
+
|
735
|
+
class Tier < Orb::BaseModel
|
736
|
+
# Per-event basis point rate
|
737
|
+
sig { returns(Float) }
|
738
|
+
attr_accessor :bps
|
739
|
+
|
740
|
+
# Inclusive tier starting value
|
741
|
+
sig { returns(String) }
|
742
|
+
attr_accessor :minimum_amount
|
743
|
+
|
744
|
+
# Exclusive tier ending value
|
745
|
+
sig { returns(T.nilable(String)) }
|
746
|
+
attr_accessor :maximum_amount
|
747
|
+
|
748
|
+
# Per unit maximum to charge
|
749
|
+
sig { returns(T.nilable(String)) }
|
750
|
+
attr_accessor :per_unit_maximum
|
751
|
+
|
752
|
+
sig do
|
753
|
+
params(
|
754
|
+
bps: Float,
|
755
|
+
minimum_amount: String,
|
756
|
+
maximum_amount: T.nilable(String),
|
757
|
+
per_unit_maximum: T.nilable(String)
|
758
|
+
)
|
759
|
+
.returns(T.attached_class)
|
760
|
+
end
|
761
|
+
def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil)
|
762
|
+
end
|
763
|
+
|
764
|
+
sig do
|
765
|
+
override
|
766
|
+
.returns(
|
767
|
+
{
|
768
|
+
bps: Float,
|
769
|
+
minimum_amount: String,
|
770
|
+
maximum_amount: T.nilable(String),
|
771
|
+
per_unit_maximum: T.nilable(String)
|
772
|
+
}
|
773
|
+
)
|
774
|
+
end
|
775
|
+
def to_hash
|
776
|
+
end
|
777
|
+
end
|
778
|
+
end
|
779
|
+
|
780
|
+
class BpsConfig < Orb::BaseModel
|
781
|
+
# Basis point take rate per event
|
782
|
+
sig { returns(Float) }
|
783
|
+
attr_accessor :bps
|
784
|
+
|
785
|
+
# Optional currency amount maximum to cap spend per event
|
786
|
+
sig { returns(T.nilable(String)) }
|
787
|
+
attr_accessor :per_unit_maximum
|
788
|
+
|
789
|
+
sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) }
|
790
|
+
def self.new(bps:, per_unit_maximum: nil)
|
791
|
+
end
|
792
|
+
|
793
|
+
sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) }
|
794
|
+
def to_hash
|
795
|
+
end
|
796
|
+
end
|
797
|
+
|
798
|
+
class BulkBpsConfig < Orb::BaseModel
|
799
|
+
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
800
|
+
# tier based on total volume
|
801
|
+
sig { returns(T::Array[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier]) }
|
802
|
+
attr_accessor :tiers
|
803
|
+
|
804
|
+
sig do
|
805
|
+
params(tiers: T::Array[T.any(Orb::Models::PriceCreateParams::BulkBpsConfig::Tier, Orb::Util::AnyHash)])
|
806
|
+
.returns(T.attached_class)
|
807
|
+
end
|
808
|
+
def self.new(tiers:)
|
809
|
+
end
|
810
|
+
|
811
|
+
sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier]}) }
|
812
|
+
def to_hash
|
813
|
+
end
|
814
|
+
|
815
|
+
class Tier < Orb::BaseModel
|
816
|
+
# Basis points to rate on
|
817
|
+
sig { returns(Float) }
|
818
|
+
attr_accessor :bps
|
819
|
+
|
820
|
+
# Upper bound for tier
|
821
|
+
sig { returns(T.nilable(String)) }
|
822
|
+
attr_accessor :maximum_amount
|
823
|
+
|
824
|
+
# The maximum amount to charge for any one event
|
825
|
+
sig { returns(T.nilable(String)) }
|
826
|
+
attr_accessor :per_unit_maximum
|
827
|
+
|
828
|
+
sig do
|
829
|
+
params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String))
|
830
|
+
.returns(T.attached_class)
|
831
|
+
end
|
832
|
+
def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil)
|
833
|
+
end
|
834
|
+
|
835
|
+
sig do
|
836
|
+
override.returns(
|
837
|
+
{
|
838
|
+
bps: Float,
|
839
|
+
maximum_amount: T.nilable(String),
|
840
|
+
per_unit_maximum: T.nilable(String)
|
841
|
+
}
|
842
|
+
)
|
843
|
+
end
|
844
|
+
def to_hash
|
845
|
+
end
|
846
|
+
end
|
847
|
+
end
|
848
|
+
|
849
|
+
class BulkConfig < Orb::BaseModel
|
850
|
+
# Bulk tiers for rating based on total usage volume
|
851
|
+
sig { returns(T::Array[Orb::Models::PriceCreateParams::BulkConfig::Tier]) }
|
852
|
+
attr_accessor :tiers
|
853
|
+
|
854
|
+
sig do
|
855
|
+
params(tiers: T::Array[T.any(Orb::Models::PriceCreateParams::BulkConfig::Tier, Orb::Util::AnyHash)])
|
856
|
+
.returns(T.attached_class)
|
857
|
+
end
|
858
|
+
def self.new(tiers:)
|
859
|
+
end
|
860
|
+
|
861
|
+
sig { override.returns({tiers: T::Array[Orb::Models::PriceCreateParams::BulkConfig::Tier]}) }
|
862
|
+
def to_hash
|
863
|
+
end
|
864
|
+
|
865
|
+
class Tier < Orb::BaseModel
|
866
|
+
# Amount per unit
|
867
|
+
sig { returns(String) }
|
868
|
+
attr_accessor :unit_amount
|
869
|
+
|
870
|
+
# Upper bound for this tier
|
871
|
+
sig { returns(T.nilable(Float)) }
|
872
|
+
attr_accessor :maximum_units
|
873
|
+
|
874
|
+
sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) }
|
875
|
+
def self.new(unit_amount:, maximum_units: nil)
|
876
|
+
end
|
877
|
+
|
878
|
+
sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) }
|
879
|
+
def to_hash
|
880
|
+
end
|
881
|
+
end
|
882
|
+
end
|
883
|
+
end
|
884
|
+
end
|
885
|
+
end
|